SortedCatalog.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
/*
 * LSST Data Management System
 * Copyright 2008, 2009, 2010, 2011 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */
#ifndef AFW_TABLE_SortedCatalog_h_INCLUDED
#define AFW_TABLE_SortedCatalog_h_INCLUDED
 
#include "lsst/afw/fitsDefaults.h"
#include "lsst/afw/table/fwd.h"
#include "lsst/afw/table/Catalog.h"
 
namespace lsst {
namespace afw {
namespace table {

template <typename RecordT>
class SortedCatalogT : public CatalogT<RecordT> {
    using Base = CatalogT<RecordT>;
 
public:
    using Record = RecordT;
    using Table = typename Record::Table;
 
    using iterator = typename Base::iterator;
    using const_iterator = typename Base::const_iterator;
 
    using Base::isSorted;
    using Base::sort;
    using Base::find;
 
    SortedCatalogT(SortedCatalogT const&) = default;
    SortedCatalogT(SortedCatalogT&&) noexcept = default;
    SortedCatalogT& operator=(SortedCatalogT const&) = default;
    SortedCatalogT& operator=(SortedCatalogT&&) = default;
    ~SortedCatalogT() = default;

    bool isSorted() const { return this->isSorted(Table::getIdKey()); }

    void sort() { this->sort(Table::getIdKey()); }


    iterator find(RecordId id) { return this->find(id, Table::getIdKey()); }
    const_iterator find(RecordId id) const { return this->find(id, Table::getIdKey()); }

    explicit SortedCatalogT(std::shared_ptr<Table> const& table = std::shared_ptr<Table>()) : Base(table) {}

    explicit SortedCatalogT(Schema const& schema) : Base(schema) {}

    template <typename InputIterator>
    SortedCatalogT(std::shared_ptr<Table> const& table, InputIterator first, InputIterator last,
                   bool deep = false)
            : Base(table, first, last, deep) {}

    template <typename OtherRecordT>
    SortedCatalogT(SortedCatalogT<OtherRecordT> const& other) : Base(other) {}

    static SortedCatalogT readFits(std::string const& filename, int hdu = fits::DEFAULT_HDU, int flags = 0) {
        return io::FitsReader::apply<SortedCatalogT>(filename, hdu, flags);
    }

    static SortedCatalogT readFits(fits::MemFileManager& manager, int hdu = fits::DEFAULT_HDU,
                                   int flags = 0) {
        return io::FitsReader::apply<SortedCatalogT>(manager, hdu, flags);
    }

    static SortedCatalogT readFits(fits::Fits& fitsfile, int flags = 0) {
        return io::FitsReader::apply<SortedCatalogT>(fitsfile, flags);
    }

    SortedCatalogT<RecordT> subset(ndarray::Array<bool const, 1> const& mask) const {
        return SortedCatalogT(Base::subset(mask));
    }

    SortedCatalogT subset(std::ptrdiff_t startd, std::ptrdiff_t stopd, std::ptrdiff_t step) const {
        return SortedCatalogT(Base::subset(startd, stopd, step));
    }
 
protected:
    explicit SortedCatalogT(Base const& other) : Base(other) {}
};
}  // namespace table
}  // namespace afw
}  // namespace lsst
 
#endif  // !AFW_TABLE_SortedCatalog_h_INCLUDED