lsst::afw::math::BoundedField Class Reference

An abstract base class for 2-d functions defined on an integer bounding boxes. More...

#include <BoundedField.h>

Inheritance diagram for lsst::afw::math::BoundedField:

Public Member Functions
virtual double	evaluate (lsst::geom::Point2D const &position) const =0
	Evaluate the field at the given point. More...
double	evaluate (double x, double y) const
	Evaluate the field at the given point. More...
virtual ndarray::Array< double, 1, 1 >	evaluate (ndarray::Array< double const, 1 > const &x, ndarray::Array< double const, 1 > const &y) const
	Evaluate the field at multiple arbitrary points. More...
virtual double	integrate () const
	Compute the integral of this function over its bounding-box. More...
virtual double	mean () const
	Compute the mean of this function over its bounding-box. More...
lsst::geom::Box2I	getBBox () const
	Return the bounding box that defines the region where the field is valid. More...
template<typename T >
void	fillImage (image::Image< T > &image, bool overlapOnly=false, int xStep=1, int yStep=1) const
	Assign the field to an image, overwriting values already present. More...
template<typename T >
void	addToImage (image::Image< T > &image, double scaleBy=1.0, bool overlapOnly=false, int xStep=1, int yStep=1) const
	Add the field or a constant multiple of it to an image in-place. More...
template<typename T >
void	multiplyImage (image::Image< T > &image, bool overlapOnly=false, int xStep=1, int yStep=1) const
	Multiply an image by the field in-place. More...
template<typename T >
void	divideImage (image::Image< T > &image, bool overlapOnly=false, int xStep=1, int yStep=1) const
	Divide an image by the field in-place. More...
virtual std::shared_ptr< BoundedField >	operator* (double const scale) const =0
	Return a scaled BoundedField. More...
std::shared_ptr< BoundedField >	operator/ (double scale) const
virtual bool	operator== (BoundedField const &rhs) const =0
	BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal. More...
bool	operator!= (BoundedField const &rhs) const
	BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal. More...
	~BoundedField () override=default
	BoundedField (BoundedField const &)=default
	BoundedField (BoundedField &&)=default
BoundedField &	operator= (BoundedField const &)=delete
BoundedField &	operator= (BoundedField &&)=delete
void	writeFits (std::string const &fileName, std::string const &mode="w") const
	Write the object to a regular FITS file. More...
void	writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
	Write the object to a FITS image in memory. More...
void	writeFits (fits::Fits &fitsfile) const
	Write the object to an already-open FITS object. More...
virtual bool	isPersistable () const noexcept
	Return true if this particular object can be persisted using afw::table::io. More...

Static Public Member Functions
static std::shared_ptr< BoundedField >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...
static std::shared_ptr< BoundedField >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file. More...
static std::shared_ptr< BoundedField >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory. More...
static std::shared_ptr< BoundedField >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr. More...

Protected Types
using	OutputArchiveHandle = io::OutputArchiveHandle

Protected Member Functions
	BoundedField (lsst::geom::Box2I const &bbox)
virtual std::string	getPersistenceName () const
	Return the unique name used to persist this object and look up its factory. More...
virtual std::string	getPythonModule () const
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...
virtual void	write (OutputArchiveHandle &handle) const
	Write the object to one or more catalogs. More...

Private Member Functions
virtual std::string	toString () const =0

Friends
std::ostream &	operator<< (std::ostream &os, BoundedField const &bf)

Detailed Description

An abstract base class for 2-d functions defined on an integer bounding boxes.

Integer bounding boxes (lsst::geom::Box2I) are inclusive of the end pixels (integer positions correspond to the centers of the pixels and include the entirety of those pixels). Thus a BoundedField defined on the box [x0, x1] x [y0, y1] actually covers the range [x0 - 0.5, x1 + 0.5] x [y0 - 0.5, y1 + 0.5].

BoundedField provides a number of ways of accessing the function, all delegating to a single evaluate-at-a-point implementation. The base class does not mandate anything about how the field is constructed, so it's appropriate for use with e.g. model-fitting results, interpolation results points, or functions known a priori.

Usually, BoundedField will be used to represent functions that correspond to images, for quantities such as aperture corrections, photometric scaling, PSF model parameters, or backgrounds, and its bounding box will be set to match the PARENT bounding box of the image.

Definition at line 55 of file BoundedField.h.

Member Typedef Documentation

OutputArchiveHandle

using lsst::afw::table::io::Persistable::OutputArchiveHandle = io::OutputArchiveHandle

protectedinherited

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

~BoundedField()

lsst::afw::math::BoundedField::~BoundedField ( )

overridedefault

BoundedField() [1/3]

lsst::afw::math::BoundedField::BoundedField ( BoundedField const &  )

default

BoundedField() [2/3]

lsst::afw::math::BoundedField::BoundedField ( BoundedField &&  )

default

BoundedField() [3/3]

lsst::afw::math::BoundedField::BoundedField ( lsst::geom::Box2I const &  bbox )

inlineexplicitprotected

Definition at line 208 of file BoundedField.h.

: _bbox(bbox) {}

Member Function Documentation

addToImage()

template<typename T >

template void lsst::afw::math::BoundedField::addToImage	(	image::Image< T > &	image,
		double	scaleBy = 1.0,
		bool	overlapOnly = false,
		int	xStep = 1,
		int	yStep = 1
	)		const

Add the field or a constant multiple of it to an image in-place.

Parameters

[out]	image	Image to add to.
[in]	scaleBy	Multiply the field by this before adding it to the image.
[in]	overlapOnly	If true, only modify the region in the intersection of image.getBBox(image::PARENT) and this->getBBox().
[in]	xStep	Distance between grid points in X to evaluate; values between grid points will be linearly interpolated.
[in]	yStep	Distance between grid points in Y to evaluate; values between grid points will be linearly interpolated.

Exceptions

pex::exceptions::RuntimeError

if the bounding boxes do not overlap and overlapOnly=false.

Definition at line 264 of file BoundedField.cc.

                                               {
    applyToImage(*this, img, ScaledAdd(scaleBy), overlapOnly, xStep, yStep);
}

divideImage()

template<typename T >

template void lsst::afw::math::BoundedField::divideImage	(	image::Image< T > &	image,
		bool	overlapOnly = false,
		int	xStep = 1,
		int	yStep = 1
	)		const

Divide an image by the field in-place.

Parameters

[out]	image	Image to fill.
[in]	overlapOnly	If true, only modify the region in the intersection of image.getBBox(image::PARENT) and this->getBBox().
[in]	xStep	Distance between grid points in X to evaluate; values between grid points will be linearly interpolated.
[in]	yStep	Distance between grid points in Y to evaluate; values between grid points will be linearly interpolated.

Exceptions

pex::exceptions::RuntimeError

if the bounding boxes do not overlap and overlapOnly=false.

Definition at line 275 of file BoundedField.cc.

                                                                                               {
    applyToImage(*this, img, Divide(), overlapOnly, xStep, yStep);
}

dynamicCast()

template std::shared_ptr< meas::extensions::psfex::PsfexPsf > lsst::afw::table::io::PersistableFacade< BoundedField >::dynamicCast ( std::shared_ptr< Persistable > const &  ptr )

staticinherited

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

You must provide an explicit template instantiation in the .cc file for each class that inherits from PersistableFacade. Designed to work around RTTI issues on macOS with hidden symbols;

Exceptions

lsst::pex::exceptions::LogicError

if the cast fails

param[in] ptr The pointer to be cast.

Returns

The cast pointer.

Exceptions

lsst::pex::exceptions::TypeError

If the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

                                                                                        {
    auto result = std::dynamic_pointer_cast<T>(ptr);
    if (!result) {
        throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
    }
    return result;
}

evaluate() [1/3]

double lsst::afw::math::BoundedField::evaluate ( double  x, double  y  ) const

inline

Evaluate the field at the given point.

This delegates to the evaluate() method that takes lsst::geom::Point2D.

There is no bounds-checking on the given position; this is the responsibility of the user, who can almost always do it more efficiently.

Definition at line 75 of file BoundedField.h.

{ return evaluate(lsst::geom::Point2D(x, y)); }

evaluate() [2/3]

virtual double lsst::afw::math::BoundedField::evaluate ( lsst::geom::Point2D const &  position ) const

pure virtual

Evaluate the field at the given point.

This is the only abstract method to be implemented by subclasses.

Subclasses should not provide bounds checking on the given position; this is the responsibility of the user, who can almost always do it more efficiently.

Implemented in lsst::afw::math::TransformBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::ChebyshevBoundedField, and lsst::meas::algorithms::CoaddBoundedField.

evaluate() [3/3]

ndarray::Array< double, 1, 1 > lsst::afw::math::BoundedField::evaluate ( ndarray::Array< double const, 1 > const &  x, ndarray::Array< double const, 1 > const &  y  ) const

virtual

Evaluate the field at multiple arbitrary points.

Parameters

[in]	x	array of x coordinates, same shape as y
[in]	y	array of y coordinates, same shape as x

Returns

an array of output values, same shape as x and y

There is no bounds-checking on the given positions; this is the responsibility of the user, who can almost always do it more efficiently.

Reimplemented in lsst::afw::math::TransformBoundedField, lsst::afw::math::ProductBoundedField, and lsst::afw::math::PixelAreaBoundedField.

Definition at line 40 of file BoundedField.cc.

                                                                                                  {
    ndarray::Array<double, 1, 1> out = ndarray::allocate(x.getSize<0>());
    for (int i = 0, n = x.getSize<0>(); i < n; ++i) {
        out[i] = evaluate(x[i], y[i]);
    }
    return out;
}

fillImage()

template<typename T >

template void lsst::afw::math::BoundedField::fillImage	(	image::Image< T > &	image,
		bool	overlapOnly = false,
		int	xStep = 1,
		int	yStep = 1
	)		const

Assign the field to an image, overwriting values already present.

Parameters

[out]	image	Image to fill.
[in]	overlapOnly	If true, only modify the region in the intersection of image.getBBox(image::PARENT) and this->getBBox().
[in]	xStep	Distance between grid points in X to evaluate; values between grid points will be linearly interpolated.
[in]	yStep	Distance between grid points in Y to evaluate; values between grid points will be linearly interpolated.

Exceptions

pex::exceptions::RuntimeError

if the bounding boxes do not overlap and overlapOnly=false.

Definition at line 259 of file BoundedField.cc.

                                                                                             {
    applyToImage(*this, img, Assign(), overlapOnly, xStep, yStep);
}

getBBox()

lsst::geom::Box2I lsst::afw::math::BoundedField::getBBox ( ) const

inline

Return the bounding box that defines the region where the field is valid.

Because this is an integer bounding box, its minimum and maximum positions are the centers of the pixels where the field is valid, but the field can be assumed to be valid to the edges of those pixels, which is the boundary you'd get by converting the returned lsst::geom::Box2I into a lsst::geom::Box2D.

Definition at line 112 of file BoundedField.h.

{ return _bbox; }

getPersistenceName()

std::string lsst::afw::table::io::Persistable::getPersistenceName ( ) const

protectedvirtualinherited

Return the unique name used to persist this object and look up its factory.

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

Reimplemented in lsst::meas::modelfit::Mixture, lsst::meas::algorithms::WarpedPsf, lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::DoubleGaussianPsf, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::CoaddBoundedField, lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::math::WarpingControl, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::TransformBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::AnalyticKernel, lsst::afw::math::FixedKernel, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::math::ChebyshevBoundedField, lsst::afw::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::image::CoaddInputs, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::detection::GaussianPsf, lsst::afw::detection::Footprint, lsst::afw::cameraGeom::DetectorCollection, and lsst::afw::image::FilterLabel.

Definition at line 34 of file Persistable.cc.

{ return std::string(); }

getPythonModule()

std::string lsst::afw::table::io::Persistable::getPythonModule ( ) const

protectedvirtualinherited

Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.

Must be less than ArchiveIndexSchema::MAX_MODULE_LENGTH characters.

Will be ignored if empty.

Reimplemented in lsst::meas::modelfit::Mixture, lsst::meas::algorithms::WarpedPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::CoaddBoundedField, lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::math::WarpingControl, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::TransformBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::Kernel, lsst::afw::math::Function< ReturnT >, lsst::afw::math::ChebyshevBoundedField, lsst::afw::image::TransmissionCurve, lsst::afw::image::CoaddInputs, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::SkyWcs, lsst::afw::detection::GaussianPsf, lsst::afw::detection::Footprint, lsst::afw::cameraGeom::DetectorCollection, and lsst::afw::image::FilterLabel.

Definition at line 36 of file Persistable.cc.

{ return std::string(); }

integrate()

double lsst::afw::math::BoundedField::integrate ( ) const

virtual

Compute the integral of this function over its bounding-box.

Returns

The value of the integral.

Reimplemented in lsst::afw::math::ChebyshevBoundedField.

Definition at line 49 of file BoundedField.cc.

{ throw LSST_EXCEPT(pex::exceptions::LogicError, "Not Implemented"); }

isPersistable()

virtual bool lsst::afw::table::io::Persistable::isPersistable ( ) const

inlinevirtualnoexceptinherited

Return true if this particular object can be persisted using afw::table::io.

Reimplemented in lsst::meas::modelfit::Mixture, lsst::meas::extensions::psfex::PsfexPsf, lsst::meas::algorithms::WarpedPsf, lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::DoubleGaussianPsf, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::CoaddBoundedField, lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::math::WarpingControl, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::TransformBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::AnalyticKernel, lsst::afw::math::FixedKernel, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::math::ChebyshevBoundedField, lsst::afw::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::image::FilterLabel, lsst::afw::image::CoaddInputs, lsst::afw::image::ApCorrMap, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::SpanSet, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, lsst::afw::detection::GaussianPsf, lsst::afw::detection::Footprint, lsst::afw::cameraGeom::TransformMap, lsst::afw::cameraGeom::DetectorCollection, lsst::afw::cameraGeom::Detector, and lsst::afw::cameraGeom::Camera.

Definition at line 102 of file Persistable.h.

{ return false; }

mean()

double lsst::afw::math::BoundedField::mean ( ) const

virtual

Compute the mean of this function over its bounding-box.

Returns

The value of the mean.

Reimplemented in lsst::afw::math::ChebyshevBoundedField.

Definition at line 51 of file BoundedField.cc.

{ throw LSST_EXCEPT(pex::exceptions::LogicError, "Not Implemented"); }

multiplyImage()

template<typename T >

template void lsst::afw::math::BoundedField::multiplyImage	(	image::Image< T > &	image,
		bool	overlapOnly = false,
		int	xStep = 1,
		int	yStep = 1
	)		const

Multiply an image by the field in-place.

Parameters

[out]	image	Image to fill.
[in]	overlapOnly	If true, only modify the region in the intersection of image.getBBox(image::PARENT) and this->getBBox().
[in]	xStep	Distance between grid points in X to evaluate; values between grid points will be linearly interpolated.
[in]	yStep	Distance between grid points in Y to evaluate; values between grid points will be linearly interpolated.

Exceptions

pex::exceptions::RuntimeError

if the bounding boxes do not overlap and overlapOnly=false.

Definition at line 270 of file BoundedField.cc.

                                                                                                 {
    applyToImage(*this, img, Multiply(), overlapOnly, xStep, yStep);
}

operator!=()

bool lsst::afw::math::BoundedField::operator!= ( BoundedField const &  rhs ) const

inline

BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal.

Definition at line 195 of file BoundedField.h.

{ return !(*this == rhs); };

operator*()

virtual std::shared_ptr<BoundedField> lsst::afw::math::BoundedField::operator* ( double const  scale ) const

pure virtual

Return a scaled BoundedField.

Parameters

[in]

scale

Scaling factor

Implemented in lsst::meas::algorithms::CoaddBoundedField, lsst::afw::math::TransformBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::PixelAreaBoundedField, and lsst::afw::math::ChebyshevBoundedField.

operator/()

std::shared_ptr<BoundedField> lsst::afw::math::BoundedField::operator/ ( double  scale ) const

inline

Definition at line 190 of file BoundedField.h.

{ return (*this) * (1.0 / scale); }

operator=() [1/2]

BoundedField& lsst::afw::math::BoundedField::operator= ( BoundedField &&  )

delete

operator=() [2/2]

BoundedField& lsst::afw::math::BoundedField::operator= ( BoundedField const &  )

delete

operator==()

virtual bool lsst::afw::math::BoundedField::operator== ( BoundedField const &  rhs ) const

pure virtual

BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal.

Implemented in lsst::afw::math::TransformBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::PixelAreaBoundedField, and lsst::afw::math::ChebyshevBoundedField.

readFits() [1/3]

static std::shared_ptr<BoundedField > lsst::afw::table::io::PersistableFacade< BoundedField >::readFits ( fits::Fits &  fitsfile )

inlinestaticinherited

Read an object from an already open FITS object.

Parameters

[in]

fitsfile

FITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

                                                         {
        return dynamicCast(Persistable::_readFits(fitsfile));
    }

readFits() [2/3]

static std::shared_ptr<BoundedField > lsst::afw::table::io::PersistableFacade< BoundedField >::readFits ( fits::MemFileManager &  manager, int  hdu = fits::DEFAULT_HDU  )

inlinestaticinherited

Read an object from a FITS file in memory.

Parameters

[in]	manager	Manager for the memory to read from.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 205 of file Persistable.h.

                                                                                             {
        return dynamicCast(Persistable::_readFits(manager, hdu));
    }

readFits() [3/3]

static std::shared_ptr<BoundedField > lsst::afw::table::io::PersistableFacade< BoundedField >::readFits ( std::string const &  fileName, int  hdu = fits::DEFAULT_HDU  )

inlinestaticinherited

Read an object from a regular FITS file.

Parameters

[in]	fileName	Name of the file to read.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 194 of file Persistable.h.

                                                                                           {
        return dynamicCast(Persistable::_readFits(fileName, hdu));
    }

toString()

virtual std::string lsst::afw::math::BoundedField::toString ( ) const

privatepure virtual

write()

void lsst::afw::table::io::Persistable::write ( OutputArchiveHandle &  handle ) const

protectedvirtualinherited

Write the object to one or more catalogs.

The handle object passed to this function provides an interface for adding new catalogs and adding nested objects to the same archive (while checking for duplicates). See OutputArchiveHandle for more information.

Reimplemented in lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::image::FilterLabel, lsst::meas::modelfit::Mixture, lsst::meas::algorithms::WarpedPsf, lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::DoubleGaussianPsf, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::CoaddBoundedField, lsst::afw::math::WarpingControl, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::TransformBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::AnalyticKernel, lsst::afw::math::FixedKernel, lsst::afw::math::ChebyshevBoundedField, lsst::afw::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::image::CoaddInputs, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::detection::GaussianPsf, lsst::afw::detection::Footprint, lsst::afw::cameraGeom::DetectorCollection, lsst::afw::cameraGeom::Camera, lsst::meas::extensions::psfex::PsfexPsf, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, and lsst::afw::math::GaussianFunction2< ReturnT >.

Definition at line 38 of file Persistable.cc.

                                                   {
    assert(!isPersistable());
    throw LSST_EXCEPT(pex::exceptions::LogicError,
                      "afw::table-based persistence is not supported for this object.");
}

writeFits() [1/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::Fits &  fitsfile ) const

inherited

Write the object to an already-open FITS object.

Parameters

[in]

fitsfile

Open FITS object to write to.

Definition at line 18 of file Persistable.cc.

                                                    {
    OutputArchive archive;
    archive.put(this);
    archive.writeFits(fitsfile);
}

writeFits() [2/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::MemFileManager &  manager, std::string const &  mode = "w"  ) const

inherited

Write the object to a FITS image in memory.

Parameters

[in]	manager	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 29 of file Persistable.cc.

                                                                                    {
    fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

writeFits() [3/3]

void lsst::afw::table::io::Persistable::writeFits ( std::string const &  fileName, std::string const &  mode = "w"  ) const

inherited

Write the object to a regular FITS file.

Parameters

[in]	fileName	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 24 of file Persistable.cc.

                                                                                  {
    fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  os, BoundedField const &  bf  )

friend

Definition at line 203 of file BoundedField.h.

                                                                          {
        return os << bf.toString() << " on " << bf.getBBox();
    }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/math/BoundedField.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/src/math/BoundedField.cc