LSST Applications g04c3c9f7ca+2075667efa,g1e125bf412+5f448d5fcf,g2079a07aa2+3e9fd84d81,g2305ad1205+b635cf1488,g2bbee38e9b+6c6beb4891,g337abbeb29+6c6beb4891,g33d1c0ed96+6c6beb4891,g3a166c0a6a+6c6beb4891,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+42f171e1e6,g5c3423f6d4+d536b04327,g607f77f49a+d536b04327,g6f43f06aed+ca1339dc19,g858d7b2824+d536b04327,g8ee334c5b4+d7f9608c2f,g9963eaa53e+b3dc1655d3,g998f4353bf+d536b04327,g99cad8db69+8ef2408349,g9ddcbc5298+9a081db1e4,ga1e77700b3+2cbb763275,gadfd92a7e4+aec2f3b930,gae0086650b+585e252eca,gb0e22166c9+0e73c8378f,gb3b7280ab2+cb5fdb229e,gbb8dafda3b+a327199e22,gc120e1dc64+88074880ea,gc28159a63d+6c6beb4891,gcdd4ae20e8+bd241b2308,gcde1bda545+903e937d91,gcf0d15dbbd+bd241b2308,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+6c6beb4891,gfbcc870c63+b310236976,w.2024.23
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
lsst::afw::detection::PeakRecord Class Reference

Record class that represents a peak in a Footprint. More...

#include <Peak.h>

Inheritance diagram for lsst::afw::detection::PeakRecord:
lsst::afw::table::BaseRecord

Public Types

using Table = PeakTable
 
using ColumnView = afw::table::ColumnViewT<PeakRecord>
 
using Catalog = afw::table::CatalogT<PeakRecord>
 
using ConstCatalog = afw::table::CatalogT<const PeakRecord>
 

Public Member Functions

 PeakRecord (ConstructionToken const &token, table::detail::RecordData &&data)
 Constructor used by PeakTable.
 
 ~PeakRecord () override=default
 
 PeakRecord (PeakRecord const &)=delete
 
 PeakRecord (PeakRecord &&)=delete
 
PeakRecordoperator= (PeakRecord const &)=delete
 
PeakRecordoperator= (PeakRecord &&)=delete
 
std::shared_ptr< PeakTable const > getTable () const
 
afw::table::RecordId getId () const
 Convenience accessors for the keys in the minimal schema.
 
void setId (afw::table::RecordId id)
 
int getIx () const
 
int getIy () const
 
void setIx (int ix)
 
void setIy (int iy)
 
lsst::geom::Point2I getI () const
 
lsst::geom::Point2I getCentroid (bool) const
 
float getFx () const
 
float getFy () const
 
void setFx (float fx)
 
void setFy (float fy)
 
lsst::geom::Point2D getF () const
 
lsst::geom::Point2D getCentroid () const
 
float getPeakValue () const
 
void setPeakValue (float peakValue)
 
Schema getSchema () const
 Return the Schema that holds this record's fields and keys.
 
template<typename T >
Field< T >::Element * getElement (Key< T > const &key)
 Return a pointer to the underlying elements of a field (non-const).
 
template<typename T >
Field< T >::Element const * getElement (Key< T > const &key) const
 Return a pointer to the underlying elements of a field (const).
 
template<typename T >
Field< T >::Reference operator[] (Key< T > const &key)
 Return a reference (or reference-like type) to the field's value.
 
template<typename T >
Field< T >::ConstReference operator[] (Key< T > const &key) const
 Return a const reference (or const-reference-like type) to the field's value.
 
template<typename Ref >
Ref operator[] (ReferenceFunctorKey< Ref > const &key)
 
template<typename ConstRef >
ConstRef operator[] (ConstReferenceFunctorKey< ConstRef > const &key) const
 
template<typename T >
Field< T >::Value get (Key< T > const &key) const
 Return the value of a field for the given key.
 
template<typename T >
get (OutputFunctorKey< T > const &key) const
 Compute a calculated or aggregate field.
 
template<typename T , typename U >
void set (Key< T > const &key, U const &value)
 Set value of a field for the given key.
 
template<typename T , typename U >
void set (InputFunctorKey< T > const &key, U const &value)
 Set a calculated or aggregate field.
 
void assign (BaseRecord const &other)
 Copy all field values from other to this, requiring that they have equal schemas.
 
void assign (BaseRecord const &other, SchemaMapper const &mapper)
 Copy field values from other to this, using a mapper.
 
ndarray::Manager::Ptr getManager () const
 

Protected Member Functions

virtual void _assign (BaseRecord const &other)
 Called by assign() after transferring fields to allow subclass data members to be copied.
 
virtual void _stream (std::ostream &os) const
 Called by operator<<.
 

Friends

class PeakTable
 

Detailed Description

Record class that represents a peak in a Footprint.

Definition at line 42 of file Peak.h.

Member Typedef Documentation

◆ Catalog

Definition at line 46 of file Peak.h.

◆ ColumnView

Definition at line 45 of file Peak.h.

◆ ConstCatalog

Definition at line 47 of file Peak.h.

◆ Table

Definition at line 44 of file Peak.h.

Constructor & Destructor Documentation

◆ PeakRecord() [1/3]

lsst::afw::detection::PeakRecord::PeakRecord ( ConstructionToken const & token,
table::detail::RecordData && data )
inline

Constructor used by PeakTable.

While formally public, this constructor is conceptually and effectively protected, due to the (protected) ConstructionToken argument.

This is to allow make_shared to be used, as that cannot be used on a truly protected or private constructor.

Definition at line 58 of file Peak.h.

58 :
60 {}
char * data
Definition BaseRecord.cc:61
BaseRecord(ConstructionToken const &, detail::RecordData &&data)
Construct a record with uninitialized data.
T move(T... args)

◆ ~PeakRecord()

lsst::afw::detection::PeakRecord::~PeakRecord ( )
overridedefault

◆ PeakRecord() [2/3]

lsst::afw::detection::PeakRecord::PeakRecord ( PeakRecord const & )
delete

◆ PeakRecord() [3/3]

lsst::afw::detection::PeakRecord::PeakRecord ( PeakRecord && )
delete

Member Function Documentation

◆ _assign()

virtual void lsst::afw::table::BaseRecord::_assign ( BaseRecord const & other)
inlineprotectedvirtualinherited

Called by assign() after transferring fields to allow subclass data members to be copied.

Reimplemented in lsst::afw::table::SourceRecord, and lsst::afw::table::ExposureRecord.

Definition at line 209 of file BaseRecord.h.

209{}

◆ _stream()

void lsst::afw::table::BaseRecord::_stream ( std::ostream & os) const
protectedvirtualinherited

Called by operator<<.

Overrides should call the base class implementation and append additional fields on new lines, with the syntax "%(name)s: %(value)s".

Definition at line 152 of file BaseRecord.cc.

152 {
153 getSchema().forEach([&os, this](auto const& item) {
154 os << item.field.getName() << ": " << this->get(item.key) << std::endl;
155 });
156}
Field< T >::Value get(Key< T > const &key) const
Return the value of a field for the given key.
Definition BaseRecord.h:151
Schema getSchema() const
Return the Schema that holds this record's fields and keys.
Definition BaseRecord.h:80
void forEach(F &func) const
Apply a functor to each SchemaItem in the Schema.
Definition Schema.h:214
T endl(T... args)

◆ assign() [1/2]

void lsst::afw::table::BaseRecord::assign ( BaseRecord const & other)
inherited

Copy all field values from other to this, requiring that they have equal schemas.

Definition at line 122 of file BaseRecord.cc.

122 {
123 if (this->getSchema() != other.getSchema()) {
124 throw LSST_EXCEPT(lsst::pex::exceptions::LogicError, "Unequal schemas in record assignment.");
125 }
126 this->getSchema().forEach(CopyValue(&other, this));
127 this->_assign(other); // let derived classes assign their own stuff
128}
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition Exception.h:48
virtual void _assign(BaseRecord const &other)
Called by assign() after transferring fields to allow subclass data members to be copied.
Definition BaseRecord.h:209
Reports errors in the logical structure of the program.
Definition Runtime.h:46

◆ assign() [2/2]

void lsst::afw::table::BaseRecord::assign ( BaseRecord const & other,
SchemaMapper const & mapper )
inherited

Copy field values from other to this, using a mapper.

Definition at line 130 of file BaseRecord.cc.

130 {
131 if (!other.getSchema().contains(mapper.getInputSchema())) {
133 "Unequal schemas between input record and mapper.");
134 }
135 if (!this->getSchema().contains(mapper.getOutputSchema())) {
137 "Unequal schemas between output record and mapper.");
138 }
139 mapper.forEach(CopyValue(&other, this)); // use the functor we defined above
140 this->_assign(other); // let derived classes assign their own stuff
141}
SchemaMapper * mapper

◆ get() [1/2]

template<typename T >
Field< T >::Value lsst::afw::table::BaseRecord::get ( Key< T > const & key) const
inlineinherited

Return the value of a field for the given key.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 151 of file BaseRecord.h.

151 {
152 return key.getValue(getElement(key), _manager);
153 }
Field< T >::Element * getElement(Key< T > const &key)
Return a pointer to the underlying elements of a field (non-const).
Definition BaseRecord.h:93

◆ get() [2/2]

template<typename T >
T lsst::afw::table::BaseRecord::get ( OutputFunctorKey< T > const & key) const
inlineinherited

Compute a calculated or aggregate field.

Definition at line 172 of file BaseRecord.h.

172 {
173 return key.get(*this);
174 }

◆ getCentroid() [1/2]

lsst::geom::Point2D lsst::afw::detection::PeakRecord::getCentroid ( ) const
inline

Definition at line 89 of file Peak.h.

89{ return getF(); }
lsst::geom::Point2D getF() const
Definition Peak.h:88

◆ getCentroid() [2/2]

lsst::geom::Point2I lsst::afw::detection::PeakRecord::getCentroid ( bool ) const
inline

Definition at line 82 of file Peak.h.

82{ return getI(); }
lsst::geom::Point2I getI() const
Definition Peak.h:81

◆ getElement() [1/2]

template<typename T >
Field< T >::Element * lsst::afw::table::BaseRecord::getElement ( Key< T > const & key)
inlineinherited

Return a pointer to the underlying elements of a field (non-const).

This low-level access is intended mostly for use with serialization; users should generally prefer the safer get(), set() and operator[] member functions.

Definition at line 93 of file BaseRecord.h.

93 {
94 if (!key.isValid()) {
95 throw LSST_EXCEPT(
96 pex::exceptions::LogicError,
97 "Key is not valid (if this is a SourceRecord, make sure slot aliases have been set up).");
98 }
99 return reinterpret_cast<typename Field<T>::Element*>(reinterpret_cast<char*>(_data) +
100 key.getOffset());
101 }

◆ getElement() [2/2]

template<typename T >
Field< T >::Element const * lsst::afw::table::BaseRecord::getElement ( Key< T > const & key) const
inlineinherited

Return a pointer to the underlying elements of a field (const).

This low-level access is intended mostly for use with serialization; users should generally prefer the safer get(), set() and operator[] member functions.

Definition at line 111 of file BaseRecord.h.

111 {
112 if (!key.isValid()) {
113 throw LSST_EXCEPT(
114 pex::exceptions::LogicError,
115 "Key is not valid (if this is a SourceRecord, make sure slot aliases have been set up).");
116 }
117 return reinterpret_cast<typename Field<T>::Element const*>(reinterpret_cast<char const*>(_data) +
118 key.getOffset());
119 }

◆ getF()

lsst::geom::Point2D lsst::afw::detection::PeakRecord::getF ( ) const
inline

Definition at line 88 of file Peak.h.

88{ return lsst::geom::Point2D(getFx(), getFy()); }
Point< double, 2 > Point2D
Definition Point.h:324

◆ getFx()

float lsst::afw::detection::PeakRecord::getFx ( ) const
inline

Definition at line 235 of file Peak.h.

235{ return get(PeakTable::getFxKey()); }
static afw::table::Key< float > getFxKey()
Definition Peak.h:167

◆ getFy()

float lsst::afw::detection::PeakRecord::getFy ( ) const
inline

Definition at line 236 of file Peak.h.

236{ return get(PeakTable::getFyKey()); }
static afw::table::Key< float > getFyKey()
Definition Peak.h:168

◆ getI()

lsst::geom::Point2I lsst::afw::detection::PeakRecord::getI ( ) const
inline

Definition at line 81 of file Peak.h.

81{ return lsst::geom::Point2I(getIx(), getIy()); }
Point< int, 2 > Point2I
Definition Point.h:321

◆ getId()

afw::table::RecordId lsst::afw::detection::PeakRecord::getId ( ) const
inline

Convenience accessors for the keys in the minimal schema.

Definition at line 227 of file Peak.h.

227{ return get(PeakTable::getIdKey()); }
static afw::table::Key< afw::table::RecordId > getIdKey()
Get keys for standard fields shared by all peaks.
Definition Peak.h:164

◆ getIx()

int lsst::afw::detection::PeakRecord::getIx ( ) const
inline

Definition at line 230 of file Peak.h.

230{ return get(PeakTable::getIxKey()); }
static afw::table::Key< int > getIxKey()
Definition Peak.h:165

◆ getIy()

int lsst::afw::detection::PeakRecord::getIy ( ) const
inline

Definition at line 231 of file Peak.h.

231{ return get(PeakTable::getIyKey()); }
static afw::table::Key< int > getIyKey()
Definition Peak.h:166

◆ getManager()

ndarray::Manager::Ptr lsst::afw::table::BaseRecord::getManager ( ) const
inlineinherited

Definition at line 200 of file BaseRecord.h.

200{ return _manager; }

◆ getPeakValue()

float lsst::afw::detection::PeakRecord::getPeakValue ( ) const
inline

Definition at line 240 of file Peak.h.

240{ return get(PeakTable::getPeakValueKey()); }
static afw::table::Key< float > getPeakValueKey()
Definition Peak.h:169

◆ getSchema()

Schema lsst::afw::table::BaseRecord::getSchema ( ) const
inlineinherited

Return the Schema that holds this record's fields and keys.

Definition at line 80 of file BaseRecord.h.

80{ return _table->getSchema(); }

◆ getTable()

std::shared_ptr< PeakTable const > lsst::afw::detection::PeakRecord::getTable ( ) const
inline

Definition at line 68 of file Peak.h.

68 {
69 return std::static_pointer_cast<PeakTable const>(afw::table::BaseRecord::getTable());
70 }
std::shared_ptr< BaseTable const > getTable() const
Return the table this record is associated with.
Definition BaseRecord.h:83

◆ operator=() [1/2]

PeakRecord & lsst::afw::detection::PeakRecord::operator= ( PeakRecord && )
delete

◆ operator=() [2/2]

PeakRecord & lsst::afw::detection::PeakRecord::operator= ( PeakRecord const & )
delete

◆ operator[]() [1/4]

template<typename ConstRef >
ConstRef lsst::afw::table::BaseRecord::operator[] ( ConstReferenceFunctorKey< ConstRef > const & key) const
inlineinherited

Definition at line 190 of file BaseRecord.h.

190 {
191 return key.getConstReference(*this);
192 }

◆ operator[]() [2/4]

template<typename T >
Field< T >::Reference lsst::afw::table::BaseRecord::operator[] ( Key< T > const & key)
inlineinherited

Return a reference (or reference-like type) to the field's value.

Some field types (Point, Moments, Flag, Covariance, and SpherePoint) do not support reference access.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 129 of file BaseRecord.h.

129 {
130 return key.getReference(getElement(key), _manager);
131 }

◆ operator[]() [3/4]

template<typename T >
Field< T >::ConstReference lsst::afw::table::BaseRecord::operator[] ( Key< T > const & key) const
inlineinherited

Return a const reference (or const-reference-like type) to the field's value.

Some field types (Point, Moments, Flag, Covariance, and SpherePoint) do not support reference access.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 141 of file BaseRecord.h.

141 {
142 return key.getConstReference(getElement(key), _manager);
143 }

◆ operator[]() [4/4]

template<typename Ref >
Ref lsst::afw::table::BaseRecord::operator[] ( ReferenceFunctorKey< Ref > const & key)
inlineinherited

Definition at line 185 of file BaseRecord.h.

185 {
186 return key.getReference(*this);
187 }

◆ set() [1/2]

template<typename T , typename U >
void lsst::afw::table::BaseRecord::set ( InputFunctorKey< T > const & key,
U const & value )
inlineinherited

Set a calculated or aggregate field.

Definition at line 180 of file BaseRecord.h.

180 {
181 return key.set(*this, value);
182 }

◆ set() [2/2]

template<typename T , typename U >
void lsst::afw::table::BaseRecord::set ( Key< T > const & key,
U const & value )
inlineinherited

Set value of a field for the given key.

This method has an additional template parameter because some fields accept and convert different types to the stored field type.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 164 of file BaseRecord.h.

164 {
165 key.setValue(getElement(key), _manager, value);
166 }

◆ setFx()

void lsst::afw::detection::PeakRecord::setFx ( float fx)
inline

Definition at line 237 of file Peak.h.

237{ set(PeakTable::getFxKey(), fx); }
daf::base::PropertySet * set
Definition fits.cc:931

◆ setFy()

void lsst::afw::detection::PeakRecord::setFy ( float fy)
inline

Definition at line 238 of file Peak.h.

238{ set(PeakTable::getFyKey(), fy); }

◆ setId()

void lsst::afw::detection::PeakRecord::setId ( afw::table::RecordId id)
inline

Definition at line 228 of file Peak.h.

228{ set(PeakTable::getIdKey(), id); }

◆ setIx()

void lsst::afw::detection::PeakRecord::setIx ( int ix)
inline

Definition at line 232 of file Peak.h.

232{ set(PeakTable::getIxKey(), ix); }

◆ setIy()

void lsst::afw::detection::PeakRecord::setIy ( int iy)
inline

Definition at line 233 of file Peak.h.

233{ set(PeakTable::getIyKey(), iy); }

◆ setPeakValue()

void lsst::afw::detection::PeakRecord::setPeakValue ( float peakValue)
inline

Definition at line 241 of file Peak.h.

241{ set(PeakTable::getPeakValueKey(), peakValue); }

Friends And Related Symbol Documentation

◆ PeakTable

friend class PeakTable
friend

Definition at line 96 of file Peak.h.


The documentation for this class was generated from the following file: