lsst.gauss2d gbf99507273+b0138be388
 
Loading...
Searching...
No Matches
Public Member Functions | List of all members
lsst::gauss2d::CoordinateSystem Class Reference

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

#include <coordinatesystem.h>

Inheritance diagram for lsst::gauss2d::CoordinateSystem:
lsst::gauss2d::Object

Public Member Functions

 CoordinateSystem (double dx1=1., double dy2=1, double x_min=0, double y_min=0)
 
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
 
std::string str () const override
 Return a brief, human-readable string representation of this.
 

Additional Inherited Members

- Static Public Member Functions inherited from lsst::gauss2d::Object
static std::string_view null_str (const std::string_view &namespace_separator)
 
- Static Public Attributes inherited from lsst::gauss2d::Object
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.

Member Function Documentation

◆ 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_keywordsWhether to prefix arguments with "{name}=", where name is the arg name in the header (as with keyword arguments in Python).
namespace_separatorThe 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.

◆ str()

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

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

Implements lsst::gauss2d::Object.

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