Namespaces
	_syntax

	catalogMatches

	detail

	io

	multiMatch

	tableEnumDicts

	testUtils

	utils

Classes
class	PointKey
	A FunctorKey used to get or set a geom::Point from an (x,y) pair of int or double Keys. More...

class	CoordKey
	A FunctorKey used to get or set celestial coordinates from a pair of Angle keys. More...

class	QuadrupoleKey
	A FunctorKey used to get or set a geom::ellipses::Quadrupole from a tuple of constituent Keys. More...

class	EllipseKey
	A FunctorKey used to get or set a geom::ellipses::Ellipse from an (xx,yy,xy,x,y) tuple of Keys. More...

class	CovarianceMatrixKey

class	AliasMap
	Mapping class that holds aliases for a Schema. More...

class	AmpInfoRecord
	Geometry and electronic information about raw amplifier images. More...

class	AmpInfoTable
	Table of amplifier information (AmpInfoRecord records) More...

class	ArrayKey
	A FunctorKey used to get or set a ndarray::Array from a sequence of scalar Keys. More...

class	BitsColumn
	A packed representation of a collection of Flag field columns. More...

class	BaseColumnView
	Column-wise view into a sequence of records that have been allocated contiguously. More...

class	ColumnViewT

class	BaseRecord
	Base class for all records. More...

class	BaseTable
	Base class for all tables. More...

class	CatalogIterator
	Iterator class for CatalogT. More...

class	CatalogT
	A custom container class for records, based on std::vector. More...

struct	SchemaItem
	A simple pair-like struct for mapping a Field (name and description) with a Key (used for actual data access). More...

class	ExposureCatalogT
	Custom catalog class for ExposureRecord/Table. More...

class	ExposureRecord
	Record class used to store exposure metadata. More...

class	ExposureTable
	Table class used to store exposure metadata. More...

struct	Field
	A description of a field in a table. More...

struct	FieldBase
	Field base class default implementation (used for numeric scalars and Angle). More...

struct	FieldBase< Array< U > >
	Field base class specialization for arrays. More...

struct	FieldBase< std::string >
	Field base class specialization for strings. More...

struct	FieldBase< Flag >
	Specialization for Flag fields. More...

class	KeyBase< Flag >
	A base class for Key that allows the underlying storage field to be extracted. More...

class	Key< Flag >
	Key specialization for Flag. More...

class	OutputFunctorKey
	Base class for objects that can extract a value from a record, but are not a true Key themselves. More...

class	InputFunctorKey
	Base class for objects that can set a value on a record, but are not a true Key themselves. More...

class	FunctorKey
	Convenience base class that combines the OutputFunctorKey and InputFunctorKey. More...

class	ReferenceFunctorKey
	Base class for objects that can return a non-const reference to part of a record, but are not a true Key. More...

class	ConstReferenceFunctorKey
	Base class for objects that can return a const reference to part of a record, but are not a true Key. More...

class	Key
	A class used as a handle to a particular field in a table. More...

class	SortedCatalogT
	Custom catalog class for record/table subclasses that are guaranteed to have an ID, and should generally be sorted by that ID. More...

class	SourceColumnViewT

struct	Match
	Lightweight representation of a geometric match between two records. More...

class	IdFactory
	A polymorphic functor base class for generating record IDs for a table. More...

class	KeyBase
	A base class for Key that allows subfield keys to be extracted for some field types. More...

class	KeyBase< Array< U > >
	KeyBase specialization for Arrays. More...

class	MatchControl
	Pass parameters to algorithms that match list of sources. More...

class	Array
	Tag types used to declare specialized field types. More...

class	Schema
	Defines the fields and offsets for a table. More...

class	SubSchema
	A proxy type for name lookups in a Schema. More...

class	SchemaMapper
	A mapping between the keys of two Schemas, used to copy data between them. More...

class	SimpleRecord
	Record class that must contain a unique ID field and a celestial coordinate field. More...

class	SimpleTable
	Table class that must contain a unique ID field and a celestial coordinate field. More...

class	SlotDefinition
	Base class for helper classes that define slots on SourceTable/SourceRecord. More...

class	FluxSlotDefinition
	SlotDefinition specialization for fluxes. More...

class	CentroidSlotDefinition
	SlotDefinition specialization for centroids. More...

class	ShapeSlotDefinition
	SlotDefinition specialization for shapes. More...

struct	SlotSuite
	An aggregate containing all of the current slots used in SourceTable. More...

class	SourceRecord
	Record class that contains measurements made on a single exposure. More...

class	SourceTable
	Table class that contains measurements made on a single exposure. More...

Typedefs
typedef PointKey< int >	Point2IKey

typedef PointKey< double >	Point2DKey

typedef ColumnViewT < ExposureRecord >	ExposureColumnView

typedef ExposureCatalogT < ExposureRecord >	ExposureCatalog

typedef ExposureCatalogT < ExposureRecord const >	ConstExposureCatalog

typedef CatalogT< BaseRecord >	BaseCatalog

typedef CatalogT< BaseRecord const >	ConstBaseCatalog

typedef ColumnViewT< SimpleRecord >	SimpleColumnView

typedef SortedCatalogT < SimpleRecord >	SimpleCatalog

typedef SortedCatalogT < SimpleRecord const >	ConstSimpleCatalog

typedef SourceColumnViewT < SourceRecord >	SourceColumnView

typedef SortedCatalogT < SourceRecord >	SourceCatalog

typedef SortedCatalogT < SourceRecord const >	ConstSourceCatalog

typedef ColumnViewT < AmpInfoRecord >	AmpInfoColumnView

typedef CatalogT< AmpInfoRecord >	AmpInfoCatalog

typedef CatalogT < AmpInfoRecord const >	ConstAmpInfoCatalog

typedef Match< SimpleRecord, SimpleRecord >	SimpleMatch

typedef Match< SimpleRecord, SourceRecord >	ReferenceMatch

typedef Match< SourceRecord, SourceRecord >	SourceMatch

typedef std::vector< SimpleMatch >	SimpleMatchVector

typedef std::vector < ReferenceMatch >	ReferenceMatchVector

typedef std::vector< SourceMatch >	SourceMatchVector

typedef std::int64_t	RecordId
	Type used for unique IDs for records. More...

typedef lsst::afw::detection::Footprint	Footprint

typedef boost::mpl::vector < RecordId, std::uint16_t, std::int32_t, float, double, Angle >	ScalarFieldTypes
	An MPL vector of scalar field types. More...

typedef boost::mpl::vector < RecordId, std::uint16_t, std::int32_t, float, double, Angle, Flag, std::string, Array< std::uint16_t >, Array < int >, Array< float >, Array < double > >	FieldTypes
	An MPL vector of all field types. More...


typedef lsst::afw::coord::Coord	Coord

typedef lsst::afw::coord::IcrsCoord	IcrsCoord

typedef lsst::afw::geom::Angle	Angle

Enumerations
enum	ReadoutCorner { LL, LR, UR, UL }
	Readout corner, in the frame of reference of the assembled image. More...

enum	CoordinateType { CoordinateType::PIXEL, CoordinateType::CELESTIAL }

enum	SourceFitsFlags { SOURCE_IO_NO_FOOTPRINTS = 0x1, SOURCE_IO_NO_HEAVY_FOOTPRINTS = 0x2 }
	Bitflags to be passed to SourceCatalog::readFits and SourceCatalog::writeFits. More...

Functions
SourceMatchVector	matchXy (SourceCatalog const &cat1, SourceCatalog const &cat2, double radius, MatchControl const &mc=MatchControl())
	Compute all tuples (s1,s2,d) where s1 belings to cat1, s2 belongs to cat2 and d, the distance between s1 and s2, in pixels, is at most radius. More...

SourceMatchVector	matchXy (SourceCatalog const &cat, double radius, MatchControl const &mc=MatchControl())
	Compute all tuples (s1,s2,d) where s1 != s2, s1 and s2 both belong to cat, and d, the distance between s1 and s2, in pixels, is at most radius. More...

SourceMatchVector	matchXy (SourceCatalog const &cat1, SourceCatalog const &cat2, double radius, bool closest)
	Compute all tuples (s1,s2,d) where s1 belings to cat1, s2 belongs to cat2 and d, the distance between s1 and s2, in pixels, is at most radius. More...

SourceMatchVector	matchXy (SourceCatalog const &cat, double radius, bool symmetric)
	Compute all tuples (s1,s2,d) where s1 != s2, s1 and s2 both belong to cat, and d, the distance between s1 and s2, in pixels, is at most radius. More...

template<typename Cat1 , typename Cat2 >
std::vector< Match< typename Cat1::Record, typename Cat2::Record > >	matchRaDec (Cat1 const &cat1, Cat2 const &cat2, Angle radius, MatchControl const &mc=MatchControl())
	Compute all tuples (s1,s2,d) where s1 belings to cat1, s2 belongs to cat2 and d, the distance between s1 and s2, is at most radius. More...

template<typename Cat >
std::vector< Match< typename Cat::Record, typename Cat::Record > >	matchRaDec (Cat const &cat, Angle radius, MatchControl const &mc=MatchControl())

template<typename Cat1 , typename Cat2 >
std::vector< Match< typename Cat1::Record, typename Cat2::Record > >	matchRaDec (Cat1 const &cat1, Cat2 const &cat2, Angle radius, bool closest)
	Compute all tuples (s1,s2,d) where s1 belings to cat1, s2 belongs to cat2 and d, the distance between s1 and s2, is at most radius. More...

template<typename Cat >
std::vector< Match< typename Cat::Record, typename Cat::Record > >	matchRaDec (Cat const &cat, Angle radius, bool symmetric)

template<typename Record1 , typename Record2 >
BaseCatalog	packMatches (std::vector< Match< Record1, Record2 > > const &matches)
	Return a table representation of a MatchVector that can be used to persist it. More...

template<typename Cat1 , typename Cat2 >
std::vector< Match< typename Cat1::Record, typename Cat2::Record > >	unpackMatches (BaseCatalog const &matches, Cat1 const &cat1, Cat2 const &cat2)
	Reconstruct a MatchVector from a BaseCatalog representation of the matches and a pair of catalogs. More...


bool	operator== (CoordKey const &lhs, CoordKey const &rhs)
	Compare CoordKeys for equality using the constituent Keys. More...

bool	operator!= (CoordKey const &lhs, CoordKey const &rhs)
	Compare CoordKeys for equality using the constituent Keys. More...


template<typename RecordT , typename Catalog , typename T >
boost::shared_ptr< RecordT >	_Catalog_find (Catalog const &catalog, T const &value, Key< T > const &key)

template<typename Catalog , typename T >
int	_Catalog_lower_bound (Catalog const &catalog, T const &value, Key< T > const &key)

template<typename Catalog , typename T >
int	_Catalog_upper_bound (Catalog const &catalog, T const &value, Key< T > const &key)

template<typename Catalog , typename T >
std::pair< int, int >	_Catalog_equal_range (Catalog const &catalog, T const &value, Key< T > const &key)

Typedef Documentation

typedef CatalogT<AmpInfoRecord> lsst::afw::table.AmpInfoCatalog

Definition at line 87 of file fwd.h.

typedef ColumnViewT<AmpInfoRecord> lsst::afw::table.AmpInfoColumnView

Definition at line 85 of file fwd.h.

typedef lsst::afw::geom::Angle lsst::afw::table.Angle

Definition at line 38 of file misc.h.

typedef CatalogT< BaseRecord > lsst::afw::table::BaseCatalog

Definition at line 61 of file fwd.h.

typedef CatalogT<AmpInfoRecord const> lsst::afw::table.ConstAmpInfoCatalog

Definition at line 88 of file fwd.h.

typedef CatalogT<BaseRecord const> lsst::afw::table.ConstBaseCatalog

Definition at line 63 of file fwd.h.

typedef ExposureCatalogT< ExposureRecord const > lsst::afw::table::ConstExposureCatalog

Definition at line 421 of file Exposure.h.

typedef SortedCatalogT<SimpleRecord const> lsst::afw::table.ConstSimpleCatalog

Definition at line 70 of file fwd.h.

typedef SortedCatalogT<SourceRecord const> lsst::afw::table.ConstSourceCatalog

Definition at line 76 of file fwd.h.

typedef lsst::afw::coord::Coord lsst::afw::table.Coord

Definition at line 35 of file misc.h.

typedef ExposureCatalogT< ExposureRecord > lsst::afw::table::ExposureCatalog

Definition at line 420 of file Exposure.h.

typedef ColumnViewT< ExposureRecord > lsst::afw::table::ExposureColumnView

Definition at line 419 of file Exposure.h.

typedef boost::mpl::vector< RecordId, std::uint16_t, std::int32_t, float, double, Angle , Flag, std::string, Array<std::uint16_t>, Array<int>, Array<float>, Array<double> > lsst::afw::table.FieldTypes

An MPL vector of all field types.

Definition at line 56 of file types.h.

typedef lsst::afw::detection::Footprint lsst::afw::table.Footprint

Definition at line 60 of file Source.h.

typedef lsst::afw::coord::IcrsCoord lsst::afw::table.IcrsCoord

Definition at line 37 of file misc.h.

typedef PointKey<double> lsst::afw::table.Point2DKey

Definition at line 111 of file aggregates.h.

typedef PointKey<int> lsst::afw::table.Point2IKey

Definition at line 110 of file aggregates.h.

typedef std::int64_t lsst::afw::table.RecordId

Type used for unique IDs for records.

FITS isn't fond of uint64, so we can save a lot of pain by using signed ints here unless we really need unsigned.

Definition at line 20 of file misc.h.

typedef Match< SimpleRecord, SourceRecord > lsst::afw::table::ReferenceMatch

Definition at line 93 of file fwd.h.

typedef std::vector< ReferenceMatch > lsst::afw::table::ReferenceMatchVector

Definition at line 97 of file fwd.h.

typedef boost::mpl::vector< RecordId, std::uint16_t, std::int32_t, float, double, Angle > lsst::afw::table.ScalarFieldTypes

An MPL vector of scalar field types.

Definition at line 53 of file types.h.

typedef SortedCatalogT<SimpleRecord> lsst::afw::table.SimpleCatalog

Definition at line 69 of file fwd.h.

typedef ColumnViewT<SimpleRecord> lsst::afw::table.SimpleColumnView

Definition at line 67 of file fwd.h.

typedef Match< SimpleRecord, SimpleRecord > lsst::afw::table::SimpleMatch

Definition at line 90 of file fwd.h.

typedef std::vector< SimpleMatch > lsst::afw::table::SimpleMatchVector

Definition at line 96 of file fwd.h.

typedef SortedCatalogT<SourceRecord> lsst::afw::table.SourceCatalog

Definition at line 75 of file fwd.h.

typedef SourceColumnViewT< SourceRecord > lsst::afw::table::SourceColumnView

Definition at line 73 of file fwd.h.

typedef Match< SourceRecord, SourceRecord > lsst::afw::table::SourceMatch

Definition at line 94 of file fwd.h.

typedef std::vector< SourceMatch > lsst::afw::table::SourceMatchVector

Definition at line 98 of file fwd.h.

Enumeration Type Documentation

enum lsst::afw::table::CoordinateType

strong

Enumerator
PIXEL
CELESTIAL

Definition at line 22 of file misc.h.

                           {
     PIXEL,
     CELESTIAL
 };

enum lsst::afw::table::ReadoutCorner

Readout corner, in the frame of reference of the assembled image.

Enumerator
LL
LR
UR
UL

Definition at line 37 of file AmpInfo.h.

                    {
     LL,
     LR,
     UR,
     UL,
 };

enum lsst::afw::table::SourceFitsFlags

Bitflags to be passed to SourceCatalog::readFits and SourceCatalog::writeFits.

Note that these flags may also be passed when reading/writing SourceCatalogs via the Butler, by passing a "flags" key/value pair as part of the data ID.

Enumerator
SOURCE_IO_NO_FOOTPRINTS	Do not read/write footprints at all.
SOURCE_IO_NO_HEAVY_FOOTPRINTS	Read/write heavy footprints as non-heavy footprints.

Definition at line 55 of file Source.h.

                      {
     SOURCE_IO_NO_FOOTPRINTS = 0x1,       
     SOURCE_IO_NO_HEAVY_FOOTPRINTS = 0x2  
 };

Function Documentation

template<typename Catalog , typename T >

std::pair<int,int> lsst::afw::table::_Catalog_equal_range	(	Catalog const &	catalog,
		T const &	value,
		Key< T > const &	key
	)

Definition at line 888 of file Catalog.h.

                                                                                                     {
     std::pair<typename Catalog::const_iterator,typename Catalog::const_iterator> p
         = catalog.equal_range(value, key);
     return std::pair<int,int>(p.first - catalog.begin(), p.second - catalog.begin());
 }

template<typename RecordT , typename Catalog , typename T >

boost::shared_ptr< RecordT > lsst::afw::table::_Catalog_find	(	Catalog const &	catalog,
		T const &	value,
		Key< T > const &	key
	)

Definition at line 869 of file Catalog.h.

                                                                                          {
     typename Catalog::const_iterator iter = catalog.find(value, key);
     if (iter == catalog.end()) {
         return PTR(RecordT)();
     }
     return iter;  // n.b. CatalogIterator is explicitly convertible to shared_ptr
 }

template<typename Catalog , typename T >

int lsst::afw::table::_Catalog_lower_bound	(	Catalog const &	catalog,
		T const &	value,
		Key< T > const &	key
	)

Definition at line 878 of file Catalog.h.

                                                                                        {
     return catalog.lower_bound(value, key) - catalog.begin();
 }

template<typename Catalog , typename T >

int lsst::afw::table::_Catalog_upper_bound	(	Catalog const &	catalog,
		T const &	value,
		Key< T > const &	key
	)

Definition at line 883 of file Catalog.h.

                                                                                        {
     return catalog.upper_bound(value, key) - catalog.begin();
 }

template<typename Cat1 , typename Cat2 >

std::vector< Match< typename Cat1::Record, typename Cat2::Record> > lsst::afw::table::matchRaDec	(	Cat1 const &	cat1,
		Cat2 const &	cat2,
		Angle	radius,
		MatchControl const &	mc = `MatchControl()`
	)

Compute all tuples (s1,s2,d) where s1 belings to cat1, s2 belongs to cat2 and d, the distance between s1 and s2, is at most radius.

If cat1 and cat2 are identical, then this call is equivalent to matchRaDec(cat1,radius). The match is performed in ra, dec space.

This is instantiated for Simple-Simple, Simple-Source, and Source-Source catalog combinations.

Parameters

cat1	first catalog
cat2	second catalog
radius	match radius
mc	how to do the matching (obeys MatchControl::findOnlyClosest)

template<typename Cat >

std::vector< Match< typename Cat::Record, typename Cat::Record> > lsst::afw::table::matchRaDec	(	Cat const &	cat,
		Angle	radius,
		MatchControl const &	mc = `MatchControl()`
	)

Parameters

cat	the catalog to self-match
radius	match radius
mc	how to do the matching (obeys MatchControl::symmetricMatch)

template<typename Cat1 , typename Cat2 >

std::vector< Match< typename Cat1::Record, typename Cat2::Record> > lsst::afw::table::matchRaDec	(	Cat1 const &	cat1,
		Cat2 const &	cat2,
		Angle	radius,
		bool	closest
	)

Compute all tuples (s1,s2,d) where s1 belings to cat1, s2 belongs to cat2 and d, the distance between s1 and s2, is at most radius.

If cat1 and cat2 are identical, then this call is equivalent to matchRaDec(cat1,radius). The match is performed in ra, dec space.

Deprecated:: . Use the matchRaDec(..., MatchControl) version

Parameters

[in]	cat1	first catalog
[in]	cat2	second catalog
[in]	radius	match radius
[in]	closest	if true then just return the closest match

This is instantiated for Simple-Simple, Simple-Source, and Source-Source catalog combinations.

template<typename Cat >

std::vector< Match< typename Cat::Record, typename Cat::Record> > lsst::afw::table::matchRaDec	(	Cat const &	cat,
		Angle	radius,
		bool	symmetric
	)

SourceMatchVector lsst::afw::table::matchXy	(	SourceCatalog const &	cat1,
		SourceCatalog const &	cat2,
		double	radius,
		MatchControl const &	mc = `MatchControl()`
	)

Compute all tuples (s1,s2,d) where s1 belings to cat1, s2 belongs to cat2 and d, the distance between s1 and s2, in pixels, is at most radius.

If cat1 and cat2 are identical, then this call is equivalent to matchXy(cat1,radius). The match is performed in pixel space (2d cartesian).

Parameters

cat1	first catalog
cat2	second catalog
radius	match radius (pixels)
mc	how to do the matching (obeys MatchControl::findOnlyClosest)

SourceMatchVector lsst::afw::table::matchXy	(	SourceCatalog const &	cat,
		double	radius,
		MatchControl const &	mc = `MatchControl()`
	)

Compute all tuples (s1,s2,d) where s1 != s2, s1 and s2 both belong to cat, and d, the distance between s1 and s2, in pixels, is at most radius.

The match is performed in pixel space (2d cartesian).

Parameters

cat	the catalog to self-match
radius	match radius (pixels)
mc	how to do the matching (obeys MatchControl::symmetricMatch)

SourceMatchVector lsst::afw::table::matchXy	(	SourceCatalog const &	cat1,
		SourceCatalog const &	cat2,
		double	radius,
		bool	closest
	)

Compute all tuples (s1,s2,d) where s1 belings to cat1, s2 belongs to cat2 and d, the distance between s1 and s2, in pixels, is at most radius.

If cat1 and cat2 are identical, then this call is equivalent to matchXy(cat1,radius). The match is performed in pixel space (2d cartesian).

Deprecated:: Please use the matchXy(..., MatchControl const&) API

Parameters

[in]	cat1	first catalog
[in]	cat2	second catalog
[in]	radius	match radius (pixels)
[in]	closest	if true then just return the closest match

SourceMatchVector lsst::afw::table::matchXy	(	SourceCatalog const &	cat,
		double	radius,
		bool	symmetric
	)

Compute all tuples (s1,s2,d) where s1 != s2, s1 and s2 both belong to cat, and d, the distance between s1 and s2, in pixels, is at most radius.

The match is performed in pixel space (2d cartesian).

Deprecated:: Please use the matchXy(..., MatchControl const&) API

Parameters

[in]	cat	the catalog to self-match
[in]	radius	match radius (pixels)
[in]	symmetric	if cat to `true` symmetric matches are produced: i.e. if (s1, s2, d) is reported, then so is (s2, s1, d).

bool lsst::afw::table::operator!=	(	CoordKey const &	lhs,
		CoordKey const &	rhs
	)

Compare CoordKeys for equality using the constituent Keys.

bool lsst::afw::table::operator==	(	CoordKey const &	lhs,
		CoordKey const &	rhs
	)

Compare CoordKeys for equality using the constituent Keys.

template<typename Record1 , typename Record2 >

BaseCatalog lsst::afw::table::packMatches ( std::vector< Match< Record1, Record2 > > const & matches )

Return a table representation of a MatchVector that can be used to persist it.

The schema of the returned object has "first" (RecordId), "second" (RecordID), and "distance" (double) fields.

Parameters

[in] matches A std::vector of Match objects to convert to table form.

template<typename Cat1 , typename Cat2 >

std::vector< Match< typename Cat1::Record, typename Cat2::Record> > lsst::afw::table::unpackMatches	(	BaseCatalog const &	matches,
		Cat1 const &	cat1,
		Cat2 const &	cat2
	)

Reconstruct a MatchVector from a BaseCatalog representation of the matches and a pair of catalogs.

Note: The first and second catalog arguments must be sorted in ascending ID order on input; this will allow us to use binary search algorithms to find the records referred to by the match table.

If an ID cannot be found in the given tables, that pointer will be set to null in the returned match vector.

Parameters

[in]	matches	A normalized BaseCatalog representation, as produced by packMatches.
[in]	cat1	A CatalogT containing the records used on the 'first' side of the match, sorted by ascending ID.
[in]	cat2	A CatalogT containing the records used on the 'second' side of the match, sorted by ascending ID. May be the same as first.

This is instantiated for Simple-Simple, Simple-Source, and Source-Source catalog combinations.

Namespaces

Classes

Typedefs

Enumerations

Functions

Typedef Documentation

Enumeration Type Documentation

Function Documentation