LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | List of all members
lsst::afw::math::TransformBoundedField Class Reference

A BoundedField based on geom::Transform<Poin2Endpoint, GenericEndpoint<1>>. More...

#include <TransformBoundedField.h>

Inheritance diagram for lsst::afw::math::TransformBoundedField:
lsst::afw::table::io::PersistableFacade< TransformBoundedField > lsst::afw::math::BoundedField lsst::afw::table::io::PersistableFacade< BoundedField > lsst::afw::table::io::Persistable

Public Types

using Transform = afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >
 

Public Member Functions

 TransformBoundedField (lsst::geom::Box2I const &bbox, Transform const &transform)
 Create a TransformBoundedField from a bounding box and transform. More...
 
 ~TransformBoundedField () override=default
 
 TransformBoundedField (TransformBoundedField const &)=default
 
 TransformBoundedField (TransformBoundedField &&)=default
 
TransformBoundedFieldoperator= (TransformBoundedField const &)=delete
 
TransformBoundedFieldoperator= (TransformBoundedField &&)=delete
 
Transform getTransform () const
 Get the contained Transform. More...
 
double evaluate (lsst::geom::Point2D const &position) const override
 Evaluate the field at the given point. More...
 
ndarray::Array< double, 1, 1 > evaluate (ndarray::Array< double const, 1 > const &x, ndarray::Array< double const, 1 > const &y) const override
 Evaluate the field at the given point. More...
 
bool isPersistable () const noexcept override
 TransformBoundedField is always persistable. More...
 
std::shared_ptr< BoundedFieldoperator* (double const scale) const override
 Return a scaled BoundedField. More...
 
bool operator== (BoundedField const &rhs) const override
 BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal. More...
 
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...
 
double evaluate (double x, double y) const
 Evaluate the field at the given point. 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...
 
std::shared_ptr< BoundedFieldoperator/ (double scale) const
 
bool operator!= (BoundedField const &rhs) const
 BoundedFields (of the same sublcass) are equal if their bounding boxes and parameters are equal. More...
 
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...
 

Static Public Member Functions

static std::shared_ptr< TransformBoundedFieldreadFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object. More...
 
static std::shared_ptr< TransformBoundedFieldreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file. More...
 
static std::shared_ptr< TransformBoundedFieldreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory. More...
 
static std::shared_ptr< TransformBoundedFielddynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr. More...
 
static std::shared_ptr< BoundedFieldreadFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object. More...
 
static std::shared_ptr< BoundedFieldreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file. More...
 
static std::shared_ptr< BoundedFieldreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory. More...
 
static std::shared_ptr< BoundedFielddynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr. More...
 

Protected Types

using OutputArchiveHandle = io::OutputArchiveHandle
 

Protected Member Functions

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

Detailed Description

A BoundedField based on geom::Transform<Poin2Endpoint, GenericEndpoint<1>>.

TransformBoundedField supports arbitrary transforms.

Definition at line 43 of file TransformBoundedField.h.

Member Typedef Documentation

◆ OutputArchiveHandle

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

Definition at line 108 of file Persistable.h.

◆ Transform

Definition at line 46 of file TransformBoundedField.h.

Constructor & Destructor Documentation

◆ TransformBoundedField() [1/3]

lsst::afw::math::TransformBoundedField::TransformBoundedField ( lsst::geom::Box2I const &  bbox,
Transform const &  transform 
)

Create a TransformBoundedField from a bounding box and transform.

Definition at line 44 of file TransformBoundedField.cc.

45  : BoundedField(bbox), _transform(transform) {
46  if (transform.getToEndpoint().getNAxes() != 1) {
47  throw LSST_EXCEPT(pex::exceptions::InvalidParameterError,
48  "To EndPoint of transform must have 1 axis but has " +
49  std::to_string(transform.getToEndpoint().getNAxes()));
50  }
51 }
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
table::Box2IKey bbox
table::Key< int > transform
BoundedField(BoundedField const &)=default
T to_string(T... args)

◆ ~TransformBoundedField()

lsst::afw::math::TransformBoundedField::~TransformBoundedField ( )
overridedefault

◆ TransformBoundedField() [2/3]

lsst::afw::math::TransformBoundedField::TransformBoundedField ( TransformBoundedField const &  )
default

◆ TransformBoundedField() [3/3]

lsst::afw::math::TransformBoundedField::TransformBoundedField ( TransformBoundedField &&  )
default

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
inherited

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

Parameters
[out]imageImage to add to.
[in]scaleByMultiply the field by this before adding it to the image.
[in]overlapOnlyIf true, only modify the region in the intersection of image.getBBox(image::PARENT) and this->getBBox().
[in]xStepDistance between grid points in X to evaluate; values between grid points will be linearly interpolated.
[in]yStepDistance between grid points in Y to evaluate; values between grid points will be linearly interpolated.
Exceptions
pex::exceptions::RuntimeErrorif the bounding boxes do not overlap and overlapOnly=false.

Definition at line 264 of file BoundedField.cc.

265  {
266  applyToImage(*this, img, ScaledAdd(scaleBy), overlapOnly, xStep, yStep);
267 }
double scaleBy
Definition: BoundedField.cc:76

◆ 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
inherited

Divide an image by the field in-place.

Parameters
[out]imageImage to fill.
[in]overlapOnlyIf true, only modify the region in the intersection of image.getBBox(image::PARENT) and this->getBBox().
[in]xStepDistance between grid points in X to evaluate; values between grid points will be linearly interpolated.
[in]yStepDistance between grid points in Y to evaluate; values between grid points will be linearly interpolated.
Exceptions
pex::exceptions::RuntimeErrorif the bounding boxes do not overlap and overlapOnly=false.

Definition at line 275 of file BoundedField.cc.

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

◆ dynamicCast() [1/2]

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::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

18  {
19  auto result = std::dynamic_pointer_cast<T>(ptr);
20  if (!result) {
21  throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
22  }
23  return result;
24 }
py::object result
Definition: _schema.cc:429
uint64_t * ptr
Definition: RangeSet.cc:88

◆ dynamicCast() [2/2]

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::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

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

◆ evaluate() [1/6]

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

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.

75 { return evaluate(lsst::geom::Point2D(x, y)); }
double x
int y
Definition: SpanSet.cc:48
virtual double evaluate(lsst::geom::Point2D const &position) const =0
Evaluate the field at the given point.

◆ evaluate() [2/6]

double lsst::afw::math::BoundedField::evaluate
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.

75 { return evaluate(lsst::geom::Point2D(x, y)); }
virtual double evaluate(lsst::geom::Point2D const &position) const=0
Evaluate the field at the given point.

◆ evaluate() [3/6]

double lsst::afw::math::TransformBoundedField::evaluate ( lsst::geom::Point2D const &  position) const
overridevirtual

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.

Implements lsst::afw::math::BoundedField.

Definition at line 53 of file TransformBoundedField.cc.

53  {
54  return _transform.applyForward(position)[0];
55 }
ToPoint applyForward(FromPoint const &point) const
Transform one point in the forward direction ("from" to "to")

◆ evaluate() [4/6]

virtual double lsst::afw::math::BoundedField::evaluate

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.

◆ evaluate() [5/6]

ndarray::Array< double, 1, 1 > lsst::afw::math::BoundedField::evaluate

Evaluate the field at multiple arbitrary points.

Parameters
[in]xarray of x coordinates, same shape as y
[in]yarray 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.

Definition at line 87 of file BoundedField.cc.

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

◆ evaluate() [6/6]

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

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.

Reimplemented from lsst::afw::math::BoundedField.

Definition at line 57 of file TransformBoundedField.cc.

58  {
59  if (x.getSize<0>() != y.getSize<0>()) {
60  throw LSST_EXCEPT(pex::exceptions::InvalidParameterError,
61  "x length " + std::to_string(x.getSize<0>()) + "!= y length " +
62  std::to_string(x.getSize<0>()));
63  }
64 
65  // TODO if Mapping.applyForward gains support for x, y (DM-11226) then use that instead of copying data
66  int const nPoints = x.getSize<0>();
67  ndarray::Array<double, 2, 2> xy = ndarray::allocate(ndarray::makeVector(2, nPoints));
68  for (int col = 0; col < nPoints; ++col) {
69  xy[0][col] = x[col];
70  xy[1][col] = y[col];
71  }
72 
73  auto res2D = _transform.getMapping()->applyForward(xy);
74 
75  // res2D has shape 1 x N; return a 1-D view with the extra dimension stripped
76  auto resShape = ndarray::makeVector(nPoints);
77  auto resStrides = ndarray::makeVector(1);
78  return ndarray::external(res2D.getData(), resShape, resStrides, res2D);
79 }
void applyForward(ConstArray2D const &from, Array2D const &to) const
Perform a forward transformation on 2-D array, putting the results into a pre-allocated 2-D array.
Definition: Mapping.h:260
std::shared_ptr< const ast::Mapping > getMapping() const
Get the contained mapping.
Definition: Transform.h:135
int col
Definition: CR.cc:144

◆ 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
inherited

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

Parameters
[out]imageImage to fill.
[in]overlapOnlyIf true, only modify the region in the intersection of image.getBBox(image::PARENT) and this->getBBox().
[in]xStepDistance between grid points in X to evaluate; values between grid points will be linearly interpolated.
[in]yStepDistance between grid points in Y to evaluate; values between grid points will be linearly interpolated.
Exceptions
pex::exceptions::RuntimeErrorif the bounding boxes do not overlap and overlapOnly=false.

Definition at line 259 of file BoundedField.cc.

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

◆ getBBox()

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

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.

112 { return _bbox; }

◆ getPersistenceName()

std::string lsst::afw::math::TransformBoundedField::getPersistenceName ( ) const
overrideprotectedvirtual

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

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 126 of file TransformBoundedField.cc.

126  {
127  return getTransformBoundedFieldPersistenceName();
128 }

◆ getPythonModule()

std::string lsst::afw::math::TransformBoundedField::getPythonModule ( ) const
overrideprotectedvirtual

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 from lsst::afw::table::io::Persistable.

Definition at line 130 of file TransformBoundedField.cc.

130 { return "lsst.afw.math"; }

◆ getTransform()

Transform lsst::afw::math::TransformBoundedField::getTransform ( ) const
inline

Get the contained Transform.

Definition at line 61 of file TransformBoundedField.h.

61 { return _transform; }

◆ integrate()

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

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.

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

◆ isPersistable()

bool lsst::afw::math::TransformBoundedField::isPersistable ( ) const
inlineoverridevirtualnoexcept

TransformBoundedField is always persistable.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 73 of file TransformBoundedField.h.

73 { return true; }

◆ mean()

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

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.

51 { 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
inherited

Multiply an image by the field in-place.

Parameters
[out]imageImage to fill.
[in]overlapOnlyIf true, only modify the region in the intersection of image.getBBox(image::PARENT) and this->getBBox().
[in]xStepDistance between grid points in X to evaluate; values between grid points will be linearly interpolated.
[in]yStepDistance between grid points in Y to evaluate; values between grid points will be linearly interpolated.
Exceptions
pex::exceptions::RuntimeErrorif the bounding boxes do not overlap and overlapOnly=false.

Definition at line 270 of file BoundedField.cc.

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

◆ operator!=()

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

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

Definition at line 195 of file BoundedField.h.

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

◆ operator*()

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

Return a scaled BoundedField.

Parameters
[in]scaleScaling factor

Implements lsst::afw::math::BoundedField.

Definition at line 141 of file TransformBoundedField.cc.

141  {
142  auto zoomMap = ast::ZoomMap(1, scale);
143  auto newMapping = getTransform().getMapping()->then(zoomMap);
144  auto newTransform = Transform(newMapping);
145  return std::make_shared<TransformBoundedField>(getBBox(), newTransform);
146 }
SeriesMap then(Mapping const &next) const
Return a series compound mapping this(first(input)) containing shallow copies of the original.
Definition: Mapping.cc:37
A Mapping which "zooms" a set of points about the origin by multiplying all coordinate values by the ...
Definition: ZoomMap.h:45
lsst::geom::Box2I getBBox() const
Return the bounding box that defines the region where the field is valid.
Definition: BoundedField.h:112
afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint > Transform
Transform getTransform() const
Get the contained Transform.
def scale(algorithm, min, max=None, frame=None)
Definition: ds9.py:108

◆ operator/()

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

Definition at line 190 of file BoundedField.h.

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

◆ operator=() [1/2]

TransformBoundedField& lsst::afw::math::TransformBoundedField::operator= ( TransformBoundedField &&  )
delete

◆ operator=() [2/2]

TransformBoundedField& lsst::afw::math::TransformBoundedField::operator= ( TransformBoundedField const &  )
delete

◆ operator==()

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

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

Implements lsst::afw::math::BoundedField.

Definition at line 148 of file TransformBoundedField.cc.

148  {
149  auto rhsCasted = dynamic_cast<TransformBoundedField const*>(&rhs);
150  if (!rhsCasted) return false;
151 
152  return getBBox() == rhsCasted->getBBox() &&
153  *(getTransform().getMapping()) == *(rhsCasted->getTransform().getMapping());
154 }
TransformBoundedField(lsst::geom::Box2I const &bbox, Transform const &transform)
Create a TransformBoundedField from a bounding box and transform.

◆ readFits() [1/6]

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]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

183  {
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }
static std::shared_ptr< BoundedField > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.
Definition: Persistable.cc:18

◆ readFits() [2/6]

Read an object from an already open FITS object.

Parameters
[in]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

183  {
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }

◆ readFits() [3/6]

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

Read an object from a FITS file in memory.

Parameters
[in]managerManager for the memory to read from.
[in]hduHDU 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.

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

◆ readFits() [4/6]

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]managerManager for the memory to read from.
[in]hduHDU 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.

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

◆ readFits() [5/6]

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]fileNameName of the file to read.
[in]hduHDU 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.

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

◆ readFits() [6/6]

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

Read an object from a regular FITS file.

Parameters
[in]fileNameName of the file to read.
[in]hduHDU 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.

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

◆ write()

void lsst::afw::math::TransformBoundedField::write ( OutputArchiveHandle handle) const
overrideprotectedvirtual

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 from lsst::afw::table::io::Persistable.

Definition at line 132 of file TransformBoundedField.cc.

132  {
133  PersistenceHelper const keys;
134  table::BaseCatalog catalog = handle.makeCatalog(keys.schema);
135  std::shared_ptr<table::BaseRecord> record = catalog.addNew();
136  record->set(keys.bbox, getBBox());
137  record->set(keys.frameSet, formatters::stringToBytes(getTransform().writeString()));
138  handle.saveCatalog(catalog);
139 }
ndarray::Array< std::uint8_t, 1, 1 > stringToBytes(std::string const &str)
Encode a std::string as a vector of uint8.
Definition: Utils.cc:161
CatalogT< BaseRecord > BaseCatalog
Definition: fwd.h:72

◆ 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]fitsfileOpen FITS object to write to.

Definition at line 18 of file Persistable.cc.

18  {
19  OutputArchive archive;
20  archive.put(this);
21  archive.writeFits(fitsfile);
22 }

◆ 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]managerName of the file to write to.
[in]modeIf "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.

29  {
30  fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
31  writeFits(fitsfile);
32 }
void writeFits(std::string const &fileName, std::string const &mode="w") const
Write the object to a regular FITS file.
Definition: Persistable.cc:24

◆ 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]fileNameName of the file to write to.
[in]modeIf "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.

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

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