lsst.meas.astrom.createMatchMetadata.MatchMetadata Class Reference

Inheritance diagram for lsst.meas.astrom.createMatchMetadata.MatchMetadata:

Public Member Functions
def	__init__
	Ctor. More...
Public Member Functions inherited from lsst::daf::base::PropertyList
	PropertyList (void)
	Constructor. More...
virtual	~PropertyList (void)
	Destructor. More...
virtual PropertySet::Ptr	deepCopy (void) const
	Copy the PropertyList and all of its contents. More...
template<typename T >
T	get (std::string const &name) const
	Get the last value for a property name (possibly hierarchical). More...
template<typename T >
T	get (std::string const &name, T const &defaultValue) const
	Get the last value for a property name (possibly hierarchical). More...
template<typename T >
std::vector< T >	getArray (std::string const &name) const
std::string const &	getComment (std::string const &name) const
	Get the comment for a string property name (possibly hierarchical). More...
std::vector< std::string >	getOrderedNames (void) const
std::list< std::string > ::const_iterator	begin (void) const
std::list< std::string > ::const_iterator	end (void) const
virtual std::string	toString (bool topLevelOnly=false, std::string const &indent="") const
	Generate a string representation of the PropertyList. More...
template<typename T >
void	set (std::string const &name, T const &value)
	Replace all values for a property name (possibly hierarchical) with a new value. More...
void	set (std::string const &name, PropertySet::Ptr const &value)
template<typename T >
void	set (std::string const &name, std::vector< T > const &value)
	Replace all values for a property name (possibly hierarchical) with a vector of new values. More...
void	set (std::string const &name, char const *value)
	Replace all values for a property name (possibly hierarchical) with a string value. More...
template<typename T >
void	add (std::string const &name, T const &value)
	Appends a single value to the vector of values for a property name (possibly hierarchical). More...
template<typename T >
void	add (std::string const &name, std::vector< T > const &value)
	Appends a vector of values to the vector of values for a property name (possibly hierarchical). More...
void	add (std::string const &name, char const *value)
	Appends a char const* value to the vector of values for a property name (possibly hierarchical). More...
template<typename T >
void	set (std::string const &name, T const &value, std::string const &comment)
	Replace all values for a property name (possibly hierarchical) with a new value. More...
template<typename T >
void	set (std::string const &name, std::vector< T > const &value, std::string const &comment)
	Replace all values for a property name (possibly hierarchical) with a vector of new values. More...
void	set (std::string const &name, char const *value, std::string const &comment)
	Replace all values for a property name (possibly hierarchical) with a string value. More...
template<typename T >
void	add (std::string const &name, T const &value, std::string const &comment)
	Appends a single value to the vector of values for a property name (possibly hierarchical). More...
template<typename T >
void	add (std::string const &name, std::vector< T > const &value, std::string const &comment)
	Appends a vector of values to the vector of values for a property name (possibly hierarchical). More...
void	add (std::string const &name, char const *value, std::string const &comment)
	Appends a char const* value to the vector of values for a property name (possibly hierarchical). More...
template<typename T >
void	set (std::string const &name, T const &value, char const *comment)
template<typename T >
void	set (std::string const &name, std::vector< T > const &value, char const *comment)
void	set (std::string const &name, char const *value, char const *comment)
template<typename T >
void	add (std::string const &name, T const &value, char const *comment)
template<typename T >
void	add (std::string const &name, std::vector< T > const &value, char const *comment)
void	add (std::string const &name, char const *value, char const *comment)
virtual void	copy (std::string const &dest, PropertySet::ConstPtr source, std::string const &name)
	Replaces a single value vector in the destination with one from the source. More...
virtual void	combine (PropertySet::ConstPtr source)
	Appends all value vectors from the source to their corresponding properties. More...
virtual void	remove (std::string const &name)
	Removes all values for a property name (possibly hierarchical). More...
template<typename T >
vector< T >	getArray (string const &name) const
	Get the vector of values for a property name (possibly hierarchical). More...
Public Member Functions inherited from lsst::daf::base::PropertySet
	PropertySet (bool flat=false)
	Constructor. More...
virtual	~PropertySet (void)
	Destructor. More...
	PropertySet (const PropertySet &)=delete
PropertySet &	operator= (const PropertySet &)=delete
	PropertySet (PropertySet &&)=delete
PropertySet &	operator= (PropertySet &&)=delete
size_t	nameCount (bool topLevelOnly=true) const
	Get the number of names in the PropertySet, optionally including those in subproperties. More...
std::vector< std::string >	names (bool topLevelOnly=true) const
	Get the names in the PropertySet, optionally including those in subproperties. More...
std::vector< std::string >	paramNames (bool topLevelOnly=true) const
	Get the names of parameters (non-subproperties) in the PropertySet, optionally including those in subproperties. More...
std::vector< std::string >	propertySetNames (bool topLevelOnly=true) const
	Get the names of subproperties in the PropertySet, optionally including those in subproperties. More...
bool	exists (std::string const &name) const
	Determine if a name (possibly hierarchical) exists. More...
bool	isArray (std::string const &name) const
	Determine if a name (possibly hierarchical) has multiple values. More...
bool	isPropertySetPtr (std::string const &name) const
	Determine if a name (possibly hierarchical) is a subproperty. More...
size_t	valueCount (std::string const &name) const
	Get number of values for a property name (possibly hierarchical). More...
std::type_info const &	typeOf (std::string const &name) const
	Get the type of values for a property name (possibly hierarchical). More...
template<typename T >
T	get (std::string const &name) const
	Get the last value for a property name (possibly hierarchical). More...
template<typename T >
T	get (std::string const &name, T const &defaultValue) const
	Get the last value for a property name (possibly hierarchical). More...
template<typename T >
std::vector< T >	getArray (std::string const &name) const
bool	getAsBool (std::string const &name) const
	Get the last value for a bool property name (possibly hierarchical). More...
int	getAsInt (std::string const &name) const
	Get the last value for a bool/char/short/int property name (possibly hierarchical). More...
int64_t	getAsInt64 (std::string const &name) const
	Get the last value for a bool/char/short/int/int64_t property name (possibly hierarchical). More...
double	getAsDouble (std::string const &name) const
	Get the last value for any arithmetic property name (possibly hierarchical). More...
std::string	getAsString (std::string const &name) const
	Get the last value for a string property name (possibly hierarchical). More...
PropertySet::Ptr	getAsPropertySetPtr (std::string const &name) const
	Get the last value for a subproperty name (possibly hierarchical). More...
Persistable::Ptr	getAsPersistablePtr (std::string const &name) const
	Get the last value for a Persistable name (possibly hierarchical). More...
template<typename T >
void	set (std::string const &name, T const &value)
	Replace all values for a property name (possibly hierarchical) with a new value. More...
template<typename T >
void	set (std::string const &name, std::vector< T > const &value)
	Replace all values for a property name (possibly hierarchical) with a vector of new values. More...
void	set (std::string const &name, char const *value)
	Replace all values for a property name (possibly hierarchical) with a string value. More...
template<typename T >
void	add (std::string const &name, T const &value)
	Appends a single value to the vector of values for a property name (possibly hierarchical). More...
template<typename T >
void	add (std::string const &name, std::vector< T > const &value)
	Appends a vector of values to the vector of values for a property name (possibly hierarchical). More...
void	add (std::string const &name, char const *value)
	Appends a char const* value to the vector of values for a property name (possibly hierarchical). More...
template<typename T >
vector< T >	getArray (string const &name) const
	Get the vector of values for a property name (possibly hierarchical). More...
Public Member Functions inherited from lsst::daf::base::Persistable
	Persistable (void)
	Default constructor. More...
virtual	~Persistable (void)
	Destructor. More...
template<class Archive >
void	serialize (Archive &, unsigned int const)
	Template boost::serialization function for the base class. More...
Public Member Functions inherited from lsst::daf::base::Citizen
	Citizen (const std::type_info &)
	Citizen (Citizen const &)
	~Citizen ()
Citizen &	operator= (Citizen const &)
std::string	repr () const
	Return a string representation of a Citizen. More...
void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...
memId	getId () const
	Return the Citizen's ID. More...

Additional Inherited Members
Public Types inherited from lsst::daf::base::PropertyList
typedef std::shared_ptr < PropertyList >	Ptr
typedef std::shared_ptr < PropertyList const >	ConstPtr
Public Types inherited from lsst::daf::base::PropertySet
typedef std::shared_ptr < PropertySet >	Ptr
typedef std::shared_ptr < PropertySet const >	ConstPtr
Public Types inherited from lsst::daf::base::Persistable
typedef std::shared_ptr < Persistable >	Ptr
Public Types inherited from lsst::daf::base::Citizen
enum	{ magicSentinel = 0xdeadbeef }
typedef unsigned long	memId
	Type of the block's ID. More...
typedef memId(*	memNewCallback )(const memId cid)
	A function used to register a callback. More...
typedef memId(*	memCallback )(const Citizen *ptr)
Static Public Member Functions inherited from lsst::daf::base::Citizen
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...
static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...
static int	init ()
	Called once when the memory system is being initialised. More...
static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...
static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...
static const std::vector < const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...
static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...
static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...
static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...
static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...
static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...
Protected Member Functions inherited from lsst::daf::base::PropertySet
virtual void	_add (std::string const &name, std::shared_ptr< std::vector< boost::any > > vp)
	Finds the property name (possibly hierarchical) and appends or sets its value with the given vector of values. More...
virtual std::string	_format (std::string const &name) const

Detailed Description

Metadata required for unpersisting a match list

Definition at line 10 of file createMatchMetadata.py.

Constructor & Destructor Documentation

def lsst.meas.astrom.createMatchMetadata.MatchMetadata.__init__	(		self,
			ctrCoord,
			radius,
			filterName
	)

Ctor.

Parameters

[in]	ctrCoord,:	Coordinates of center (lsst.afw.coord.IcrsCoord)
[in]	radius,:	Minimum radius for selecting sources (lsst.afw.geom.Angle)
[in]	filterName,:	Name of filter (str) or None

Definition at line 13 of file createMatchMetadata.py.

    def __init__(self, ctrCoord, radius, filterName):
        """!Ctor

        @param[in] ctrCoord: Coordinates of center (lsst.afw.coord.IcrsCoord)
        @param[in] radius: Minimum radius for selecting sources (lsst.afw.geom.Angle)
        @param[in] filterName: Name of filter (str) or None
        """
        PropertyList.__init__(self)
        ctrCoord = ctrCoord.toIcrs()
        self.add('RA', ctrCoord.getRa().asDegrees(), 'field center in degrees')
        self.add('DEC', ctrCoord.getDec().asDegrees(), 'field center in degrees')
        self.add('RADIUS', radius.asDegrees(), 'field radius in degrees, minimum')
        self.add('SMATCHV', 1, 'SourceMatchVector version number')
        filterName = "UNKNOWN" if filterName is None else str(filterName)
        self.add('FILTER', filterName, 'filter name for photometric data')