LSSTApplications  21.0.0+1b62c9342b,21.0.0+45a059f35e,21.0.0-1-ga51b5d4+ceb9cf20a3,21.0.0-17-gf9a0284+9e5b25d042,21.0.0-2-g103fe59+513edb8842,21.0.0-2-g1367e85+d9bb5204cb,21.0.0-2-g2909d54+45a059f35e,21.0.0-2-g45278ab+1b62c9342b,21.0.0-2-g4bc9b9f+36532ac5d2,21.0.0-2-g5242d73+d9bb5204cb,21.0.0-2-g54e2caa+0b4b33a26b,21.0.0-2-g66bcc37+0525a04256,21.0.0-2-g7f82c8f+8938dec807,21.0.0-2-g8dde007+7bfb5851c8,21.0.0-2-g8f08a60+73884b2cf5,21.0.0-2-g973f35b+44678ca34c,21.0.0-2-ga326454+8938dec807,21.0.0-2-ga63a54e+682c8ce20e,21.0.0-2-ga885a99+9a92674037,21.0.0-2-gc738bc1+5ce50b2a03,21.0.0-2-gde069b7+5a8f2956b8,21.0.0-2-ge17e5af+d9bb5204cb,21.0.0-2-ge712728+d5c34dc911,21.0.0-2-gecfae73+8bdf007ced,21.0.0-2-gfc62afb+d9bb5204cb,21.0.0-21-g006371a9+5abec3504c,21.0.0-3-g4c5b185+4e2de95c30,21.0.0-3-g6d51c4a+0525a04256,21.0.0-3-gaa929c8+fca53d2b73,21.0.0-3-gd222c45+afc8332dbe,21.0.0-3-gd5de2f2+0525a04256,21.0.0-4-g3300ddd+1b62c9342b,21.0.0-4-g8a80011+23661db33a,21.0.0-5-gb7080ec+ee9551b7be,21.0.0-5-gcff38f6+e51f0852ce,21.0.0-6-gd3283ba+fca53d2b73,21.0.0-8-g19111d86+898b2b281f,21.0.0-8-gd9c33f4a0+b58bb1f4d6,w.2021.03
LSSTDataManagementBasePackage
SortedCatalog.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008, 2009, 2010, 2011 LSST Corporation.
5  *
6  * This product includes software developed by the
7  * LSST Project (http://www.lsst.org/).
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the LSST License Statement and
20  * the GNU General Public License along with this program. If not,
21  * see <http://www.lsstcorp.org/LegalNotices/>.
22  */
23 #ifndef AFW_TABLE_SortedCatalog_h_INCLUDED
24 #define AFW_TABLE_SortedCatalog_h_INCLUDED
25 
26 #include "lsst/afw/fitsDefaults.h"
27 #include "lsst/afw/table/fwd.h"
28 #include "lsst/afw/table/Catalog.h"
29 
30 namespace lsst {
31 namespace afw {
32 namespace table {
33 
41 template <typename RecordT>
42 class SortedCatalogT : public CatalogT<RecordT> {
43  typedef CatalogT<RecordT> Base;
44 
45 public:
46  typedef RecordT Record;
47  typedef typename Record::Table Table;
48 
49  typedef typename Base::iterator iterator;
51 
52  using Base::isSorted;
53  using Base::sort;
54  using Base::find;
55 
56  SortedCatalogT(SortedCatalogT const&) = default;
60  ~SortedCatalogT() = default;
61 
63  bool isSorted() const { return this->isSorted(Table::getIdKey()); }
64 
66  void sort() { this->sort(Table::getIdKey()); }
67 
69 
77  iterator find(RecordId id) { return this->find(id, Table::getIdKey()); }
78  const_iterator find(RecordId id) const { return this->find(id, Table::getIdKey()); }
80 
87  explicit SortedCatalogT(std::shared_ptr<Table> const& table = std::shared_ptr<Table>()) : Base(table) {}
88 
90  explicit SortedCatalogT(Schema const& schema) : Base(schema) {}
91 
102  template <typename InputIterator>
103  SortedCatalogT(std::shared_ptr<Table> const& table, InputIterator first, InputIterator last,
104  bool deep = false)
105  : Base(table, first, last, deep) {}
106 
113  template <typename OtherRecordT>
115 
126  static SortedCatalogT readFits(std::string const& filename, int hdu = fits::DEFAULT_HDU, int flags = 0) {
127  return io::FitsReader::apply<SortedCatalogT>(filename, hdu, flags);
128  }
129 
141  int flags = 0) {
142  return io::FitsReader::apply<SortedCatalogT>(manager, hdu, flags);
143  }
144 
152  static SortedCatalogT readFits(fits::Fits& fitsfile, int flags = 0) {
153  return io::FitsReader::apply<SortedCatalogT>(fitsfile, flags);
154  }
155 
161  SortedCatalogT<RecordT> subset(ndarray::Array<bool const, 1> const& mask) const {
163  }
164 
170  return SortedCatalogT(Base::subset(startd, stopd, step));
171  }
172 
173 protected:
174  explicit SortedCatalogT(Base const& other) : Base(other) {}
175 };
176 } // namespace table
177 } // namespace afw
178 } // namespace lsst
179 
180 #endif // !AFW_TABLE_SortedCatalog_h_INCLUDED
lsst::afw::table::SortedCatalogT::Record
RecordT Record
Definition: SortedCatalog.h:46
std::string
STL class.
std::shared_ptr< Table >
lsst::afw::table::SortedCatalogT::SortedCatalogT
SortedCatalogT(SortedCatalogT &&)=default
lsst::afw::fits::DEFAULT_HDU
const int DEFAULT_HDU
Specify that the default HDU should be read.
Definition: fitsDefaults.h:18
lsst::afw::fits::Fits
A simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition: fits.h:297
lsst::afw::table::SortedCatalogT::find
const_iterator find(RecordId id) const
Definition: SortedCatalog.h:78
lsst::afw::table._match.first
first
Definition: _match.py:74
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::table::SortedCatalogT::operator=
SortedCatalogT & operator=(SortedCatalogT const &)=default
fwd.h
lsst::afw::table::Schema
Defines the fields and offsets for a table.
Definition: Schema.h:50
lsst::afw::table::SortedCatalogT::const_iterator
Base::const_iterator const_iterator
Definition: SortedCatalog.h:50
lsst::afw::fits::MemFileManager
Lifetime-management for memory that goes into FITS memory files.
Definition: fits.h:121
mask
afw::table::Key< afw::table::Array< MaskPixelT > > mask
Definition: HeavyFootprint.cc:217
lsst::afw::table::SortedCatalogT::isSorted
bool isSorted() const
Return true if the vector is in ascending ID order.
Definition: SortedCatalog.h:63
lsst::afw::table::SortedCatalogT::Table
Record::Table Table
Definition: SortedCatalog.h:47
lsst::afw::table::CatalogT::subset
CatalogT< RecordT > subset(ndarray::Array< bool const, 1 > const &mask) const
Return the subset of a catalog corresponding to the True values of the given mask array.
Definition: Catalog.h:180
lsst::afw::table::SortedCatalogT::find
iterator find(RecordId id)
Return an iterator to the record with the given ID.
Definition: SortedCatalog.h:77
lsst::afw::table::SortedCatalogT::iterator
Base::iterator iterator
Definition: SortedCatalog.h:49
lsst::afw::table::SortedCatalogT::readFits
static SortedCatalogT readFits(fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU, int flags=0)
Read a FITS binary table from a RAM file.
Definition: SortedCatalog.h:140
lsst::afw::table::SortedCatalogT::subset
SortedCatalogT subset(std::ptrdiff_t startd, std::ptrdiff_t stopd, std::ptrdiff_t step) const
Shallow copy a subset of another SortedCatalog.
Definition: SortedCatalog.h:169
fitsDefaults.h
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::afw::table::CatalogT::find
iterator find(typename Field< T >::Value const &value, Key< T > const &key)
Return an iterator to the record with the given value.
Definition: Catalog.h:756
step
int const step
Definition: BoundedField.cc:102
lsst::afw::table::CatalogT::isSorted
bool isSorted(Key< T > const &key) const
Return true if the catalog is in ascending order according to the given key.
Definition: Catalog.h:742
lsst::afw::table::CatalogIterator
Iterator class for CatalogT.
Definition: Catalog.h:39
lsst::afw::table::SortedCatalogT::SortedCatalogT
SortedCatalogT(SortedCatalogT const &)=default
std::int64_t
lsst::afw::table::SortedCatalogT::SortedCatalogT
SortedCatalogT(Schema const &schema)
Construct a vector from a schema, creating a table with Table::make(schema).
Definition: SortedCatalog.h:90
lsst::afw::table::CatalogT::sort
void sort(Key< T > const &key)
Sort the catalog in-place by the field with the given key.
Definition: Catalog.h:749
lsst::afw::table::SortedCatalogT::SortedCatalogT
SortedCatalogT(SortedCatalogT< OtherRecordT > const &other)
Shallow copy constructor from a container containing a related record type.
Definition: SortedCatalog.h:114
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::afw::table::SortedCatalogT::SortedCatalogT
SortedCatalogT(std::shared_ptr< Table > const &table=std::shared_ptr< Table >())
Construct a vector from a table (or nothing).
Definition: SortedCatalog.h:87
schema
table::Schema schema
Definition: python.h:134
lsst::afw::table::SortedCatalogT::operator=
SortedCatalogT & operator=(SortedCatalogT &&)=default
lsst::afw::table::SortedCatalogT::sort
void sort()
Sort the vector in-place by ID.
Definition: SortedCatalog.h:66
lsst::afw::table::SortedCatalogT::SortedCatalogT
SortedCatalogT(Base const &other)
Definition: SortedCatalog.h:174
lsst::afw::table::SortedCatalogT::subset
SortedCatalogT< RecordT > subset(ndarray::Array< bool const, 1 > const &mask) const
Return the subset of a catalog corresponding to the True values of the given mask array.
Definition: SortedCatalog.h:161
std::ptrdiff_t
lsst::afw::table::SortedCatalogT::~SortedCatalogT
~SortedCatalogT()=default
Catalog.h
lsst::afw::table::CatalogT
A custom container class for records, based on std::vector.
Definition: Catalog.h:97
lsst::afw::table::SortedCatalogT::readFits
static SortedCatalogT readFits(fits::Fits &fitsfile, int flags=0)
Read a FITS binary table from a file object already at the correct extension.
Definition: SortedCatalog.h:152
lsst::afw::table::SortedCatalogT::readFits
static SortedCatalogT readFits(std::string const &filename, int hdu=fits::DEFAULT_HDU, int flags=0)
Read a FITS binary table from a regular file.
Definition: SortedCatalog.h:126
lsst::afw::table::SortedCatalogT
Custom catalog class for record/table subclasses that are guaranteed to have an ID,...
Definition: SortedCatalog.h:42
lsst::afw::table::SortedCatalogT::SortedCatalogT
SortedCatalogT(std::shared_ptr< Table > const &table, InputIterator first, InputIterator last, bool deep=false)
Construct a vector from a table and an iterator range.
Definition: SortedCatalog.h:103