LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
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  using Base = CatalogT<RecordT>;
44 
45 public:
46  using Record = RecordT;
47  using Table = typename Record::Table;
48 
49  using iterator = typename Base::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
int const step
afw::table::Key< afw::table::Array< MaskPixelT > > mask
table::Schema schema
Definition: python.h:134
A simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition: fits.h:297
Lifetime-management for memory that goes into FITS memory files.
Definition: fits.h:121
Iterator class for CatalogT.
Definition: Catalog.h:40
A custom container class for records, based on std::vector.
Definition: Catalog.h:98
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:763
CatalogIterator< typename Internal::iterator > iterator
Definition: Catalog.h:111
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:185
CatalogIterator< typename Internal::const_iterator > const_iterator
Definition: Catalog.h:112
typename Record::Table Table
Definition: Catalog.h:103
void sort(Key< T > const &key)
Sort the catalog in-place by the field with the given key.
Definition: Catalog.h:756
bool isSorted(Key< T > const &key) const
Return true if the catalog is in ascending order according to the given key.
Definition: Catalog.h:749
Defines the fields and offsets for a table.
Definition: Schema.h:51
Custom catalog class for record/table subclasses that are guaranteed to have an ID,...
Definition: SortedCatalog.h:42
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.
bool isSorted() const
Return true if the vector is in ascending ID order.
Definition: SortedCatalog.h:63
SortedCatalogT(SortedCatalogT &&)=default
SortedCatalogT subset(std::ptrdiff_t startd, std::ptrdiff_t stopd, std::ptrdiff_t step) const
Shallow copy a subset of another SortedCatalog.
iterator find(RecordId id)
Return an iterator to the record with the given ID.
Definition: SortedCatalog.h:77
SortedCatalogT(std::shared_ptr< Table > const &table, InputIterator first, InputIterator last, bool deep=false)
Construct a vector from a table and an iterator range.
static SortedCatalogT readFits(fits::Fits &fitsfile, int flags=0)
Read a FITS binary table from a file object already at the correct extension.
SortedCatalogT & operator=(SortedCatalogT const &)=default
SortedCatalogT(SortedCatalogT const &)=default
const_iterator find(RecordId id) const
Definition: SortedCatalog.h:78
SortedCatalogT(std::shared_ptr< Table > const &table=std::shared_ptr< Table >())
Construct a vector from a table (or nothing).
Definition: SortedCatalog.h:87
SortedCatalogT & operator=(SortedCatalogT &&)=default
static SortedCatalogT readFits(fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU, int flags=0)
Read a FITS binary table from a RAM file.
void sort()
Sort the vector in-place by ID.
Definition: SortedCatalog.h:66
SortedCatalogT(Base const &other)
static SortedCatalogT readFits(std::string const &filename, int hdu=fits::DEFAULT_HDU, int flags=0)
Read a FITS binary table from a regular file.
SortedCatalogT(SortedCatalogT< OtherRecordT > const &other)
Shallow copy constructor from a container containing a related record type.
SortedCatalogT(Schema const &schema)
Construct a vector from a schema, creating a table with Table::make(schema).
Definition: SortedCatalog.h:90
const int DEFAULT_HDU
Specify that the default HDU should be read.
Definition: fitsDefaults.h:18
A base class for image defects.