lsst::gauss2d::CoordinateSystem Class Reference

A coordinate system specifying image scale and orientation. More...

#include <coordinatesystem.h>

Inheritance diagram for lsst::gauss2d::CoordinateSystem:

Public Member Functions
	CoordinateSystem (double dx1=1., double dy2=1, double x_min=0, double y_min=0)
	~CoordinateSystem ()
double	get_dx1 () const
double	get_dy2 () const
double	get_x_min () const
double	get_y_min () const
bool	is_xy_aligned () const
bool	operator== (const CoordinateSystem &other) const
bool	operator!= (const CoordinateSystem &other) const
std::string	repr (bool name_keywords=false, std::string_view namespace_separator=Object::CC_NAMESPACE_SEPARATOR) const override
	Return a full, callable string representation of this.
std::string	str () const override
	Return a brief, human-readable string representation of this.

Static Public Member Functions
static std::string_view	null_str (const std::string_view &namespace_separator)

Static Public Attributes
static constexpr std::string_view	CC_NAMESPACE_SEPARATOR = "::"
	The C++ namespace separator.
static constexpr std::string_view	NULL_STR_GENERAL = "None"
static constexpr std::string_view	PY_NAMESPACE_SEPARATOR = "."

Detailed Description

A coordinate system specifying image scale and orientation.

This is intended to mimic some of the functionality of e.g. basic FITS headers, in order for evaluators to draw images at different scales and/or with rotation/translation. Rotation is not yet supported.

Definition at line 43 of file coordinatesystem.h.

Constructor & Destructor Documentation

CoordinateSystem()

lsst::gauss2d::CoordinateSystem::CoordinateSystem ( double dx1 = 1., double dy2 = 1, double x_min = 0, double y_min = 0 )

explicit

Definition at line 64 of file coordinatesystem.cc.

        : _dx1(dx1), _dy2(dy2), _x_min(x_min), _y_min(y_min) {
    std::string errmsg = "";
    if (!((dx1 != 0) && std::isfinite(dx1) && (dy2 != 0) && std::isfinite(dy2))) {
        errmsg += "dx1, dy2 = " + to_string_float(_dx1) + ", " + to_string_float(_dy2) + " ==0 or !finite; ";
    }
    if (!(std::isfinite(_x_min) && std::isfinite(_y_min))) {
        errmsg += "x_min, y_min = " + to_string_float(_x_min) + ", " + to_string_float(_y_min) + " !finite; ";
    }
    if (errmsg != "") {
        throw std::invalid_argument(errmsg);
    }
}

~CoordinateSystem()

lsst::gauss2d::CoordinateSystem::~CoordinateSystem

(

)

Definition at line 78 of file coordinatesystem.cc.

{}

Member Function Documentation

get_dx1()

double lsst::gauss2d::CoordinateSystem::get_dx1

(

)

const

Definition at line 36 of file coordinatesystem.cc.

{ return _dx1; }

get_dy2()

double lsst::gauss2d::CoordinateSystem::get_dy2

(

)

const

Definition at line 37 of file coordinatesystem.cc.

{ return _dy2; }

get_x_min()

double lsst::gauss2d::CoordinateSystem::get_x_min

(

)

const

Definition at line 39 of file coordinatesystem.cc.

{ return _x_min; }

get_y_min()

double lsst::gauss2d::CoordinateSystem::get_y_min

(

)

const

Definition at line 40 of file coordinatesystem.cc.

{ return _y_min; }

is_xy_aligned()

bool lsst::gauss2d::CoordinateSystem::is_xy_aligned

(

)

const

Definition at line 42 of file coordinatesystem.cc.

{ return true; }

null_str()

static std::string_view lsst::gauss2d::Object::null_str ( const std::string_view & namespace_separator )

inlinestaticinherited

Definition at line 49 of file object.h.

                                                                              {
        return namespace_separator == CC_NAMESPACE_SEPARATOR ? "nullptr" : NULL_STR_GENERAL;
    }

operator!=()

bool lsst::gauss2d::CoordinateSystem::operator!=

(

const CoordinateSystem &

other

)

const

Definition at line 49 of file coordinatesystem.cc.

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

operator==()

bool lsst::gauss2d::CoordinateSystem::operator==

(

const CoordinateSystem &

other

)

const

Definition at line 44 of file coordinatesystem.cc.

                                                                     {
    return (_dx1 == other.get_dx1()) && (_dy2 == other.get_dy2()) && (_x_min == other.get_x_min())
           && (_y_min == other.get_y_min());
}

repr()

std::string lsst::gauss2d::CoordinateSystem::repr ( bool name_keywords = false, std::string_view namespace_separator = Object::CC_NAMESPACE_SEPARATOR ) const

overridevirtual

Return a full, callable string representation of this.

Parameters

name_keywords	Whether to prefix arguments with "{name}=", where name is the arg name in the header (as with keyword arguments in Python).
namespace_separator	The string to use to delimit namespaces, i.e. :: in C++ and . in Python.

Returns

A callable string representation of this, which should return an an identical object to this.

Note

The representation with name_keywords=false must be callable in C++. The representation with name_keywords=true should be callable in Python, if there are any bindings.

Implements lsst::gauss2d::Object.

Definition at line 51 of file coordinatesystem.cc.

                                                                                             {
    return type_name_str<CoordinateSystem>(false, namespace_separator) + "(" + (name_keywords ? "dx1=" : "")
           + to_string_float(_dx1) + ", " + (name_keywords ? "dy2=" : "") + to_string_float(_dy2) + ", "
           + (name_keywords ? "x_min=" : "") + to_string_float(_x_min) + ", "
           + (name_keywords ? "y_min=" : "") + to_string_float(_y_min) + ")";
}

str()

std::string lsst::gauss2d::CoordinateSystem::str ( ) const

overridevirtual

Return a brief, human-readable string representation of this.

Implements lsst::gauss2d::Object.

Definition at line 58 of file coordinatesystem.cc.

                                      {
    return type_name_str<CoordinateSystem>(true) + "(dx1=" + to_string_float(_dx1)
           + ", dy2=" + to_string_float(_dy2) + ", x_min=" + to_string_float(_x_min)
           + ", y_min=" + to_string_float(_y_min) + ")";
}

Member Data Documentation

CC_NAMESPACE_SEPARATOR

constexpr std::string_view lsst::gauss2d::Object::CC_NAMESPACE_SEPARATOR = "::"

staticconstexprinherited

The C++ namespace separator.

Definition at line 45 of file object.h.

NULL_STR_GENERAL

constexpr std::string_view lsst::gauss2d::Object::NULL_STR_GENERAL = "None"

staticconstexprinherited

Definition at line 46 of file object.h.

PY_NAMESPACE_SEPARATOR

constexpr std::string_view lsst::gauss2d::Object::PY_NAMESPACE_SEPARATOR = "."

staticconstexprinherited

Definition at line 47 of file object.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/gauss2d/g9125e01d80+a8ce1bb630/include/lsst/gauss2d/coordinatesystem.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/gauss2d/g9125e01d80+a8ce1bb630/src/coordinatesystem.cc