LSST Applications g063fba187b+fee0456c91,g0f08755f38+ea96e5a5a3,g1653933729+a8ce1bb630,g168dd56ebc+a8ce1bb630,g1a2382251a+90257ff92a,g20f6ffc8e0+ea96e5a5a3,g217e2c1bcf+937a289c59,g28da252d5a+daa7da44eb,g2bbee38e9b+253935c60e,g2bc492864f+253935c60e,g3156d2b45e+6e55a43351,g32e5bea42b+31359a2a7a,g347aa1857d+253935c60e,g35bb328faa+a8ce1bb630,g3a166c0a6a+253935c60e,g3b1af351f3+a8ce1bb630,g3e281a1b8c+c5dd892a6c,g414038480c+416496e02f,g41af890bb2+afe91b1188,g599934f4f4+0db33f7991,g7af13505b9+e36de7bce6,g80478fca09+da231ba887,g82479be7b0+a4516e59e3,g858d7b2824+ea96e5a5a3,g89c8672015+f4add4ffd5,g9125e01d80+a8ce1bb630,ga5288a1d22+bc6ab8dfbd,gb58c049af0+d64f4d3760,gc28159a63d+253935c60e,gcab2d0539d+3f2b72788c,gcf0d15dbbd+4ea9c45075,gda6a2b7d83+4ea9c45075,gdaeeff99f8+1711a396fd,ge79ae78c31+253935c60e,gef2f8181fd+3031e3cf99,gf0baf85859+c1f95f4921,gfa517265be+ea96e5a5a3,gfa999e8aa5+17cd334064,w.2024.50
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
27#include "lsst/afw/table/fwd.h"
29
30namespace lsst {
31namespace afw {
32namespace table {
33
41template <typename RecordT>
42class SortedCatalogT : public CatalogT<RecordT> {
43 using Base = CatalogT<RecordT>;
44
45public:
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
88
90 explicit SortedCatalogT(Schema const& schema) : Base(schema) {}
91
102 template <typename InputIterator>
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
172
173protected:
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:308
Lifetime-management for memory that goes into FITS memory files.
Definition fits.h:125
Tag types used to declare specialized field types.
Definition misc.h:31
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:762
CatalogIterator< typename Internal::iterator > iterator
Definition Catalog.h:110
CatalogIterator< typename Internal::const_iterator > const_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:184
void sort(Key< T > const &key)
Sort the catalog in-place by the field with the given key.
Definition Catalog.h:755
bool isSorted(Key< T > const &key) const
Return true if the catalog is in ascending order according to the given key.
Definition Catalog.h:748
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,...
bool isSorted() const
Return true if the vector is in ascending ID order.
typename Base::const_iterator const_iterator
typename Base::iterator iterator
SortedCatalogT(SortedCatalogT &&)=default
SortedCatalogT & operator=(SortedCatalogT &&)=default
SortedCatalogT & operator=(SortedCatalogT const &)=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.
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(SortedCatalogT const &)=default
const_iterator find(RecordId id) const
SortedCatalogT(std::shared_ptr< Table > const &table=std::shared_ptr< Table >())
Construct a vector from a table (or nothing).
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.
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.
typename Record::Table Table
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).
const int DEFAULT_HDU
Specify that the default HDU should be read.