lsst::gauss2d::fit::Channel Class Reference

An observational channel, usually representing some range of wavelengths of light. More...

#include <channel.h>

Inheritance diagram for lsst::gauss2d::fit::Channel:

Classes
struct	Shared_enabler

Public Types
typedef std::map< std::string, std::shared_ptr< const Channel > >	Registry

Public Member Functions
	Channel (const Channel &)=delete
Channel &	operator= (const Channel &)=delete
std::string	repr (bool name_keywords=false, std::string_view namespace_separator=Object::CC_NAMESPACE_SEPARATOR) const override
std::string	str () const override
const bool	operator< (const Channel &c) const
const bool	operator== (const Channel &c) const
const bool	operator!= (const Channel &c) const

Static Public Member Functions
static void	erase (std::string name)
static const std::shared_ptr< const Channel >	find_channel (std::string name)
static const std::shared_ptr< const Channel >	get_channel (std::string name)
static std::vector< std::shared_ptr< const Channel > >	get_channels ()
static const std::shared_ptr< const Channel >	NONE_PTR ()
static const Channel &	NONE ()
static std::shared_ptr< Channel >	make (std::string name)
static const std::shared_ptr< const Channel >	make_const (std::string name)
	Same as make(), but creating a new Channel.

Public Attributes
const std::string	name

Static Public Attributes
static const std::string	NAME_NONE = "None"

Detailed Description

An observational channel, usually representing some range of wavelengths of light.

A Channel is a distinguishing property of an Observation, allowing IntegralModels to define integrals in distinct regions of some parameter space. Channels can represent a physical object such as a filter or more abstract definitions like wavelength/frequency ranges, generic labels like ABC, something inbetween like RGB, or anything else users prefer.

Note

Channels are compared and sorted alphabetically.

Member Function Documentation

erase()

void lsst::gauss2d::fit::Channel::erase ( std::string name )

static

Delete a channel with a given name.

Parameters

name	The name of the channel to delete

Exceptions

std::invalid_argument	If the channel is the default (NAME_NONE) or non-existent
std::runtime_error	If the channel is referenced by any other objects

find_channel()

const std::shared_ptr< const Channel > lsst::gauss2d::fit::Channel::find_channel ( std::string name )

static

Find a channel with the given name

Parameters

name	The name of the channel to find

Returns

The Channel is if it exists, or nullptr otherwise

get_channel()

const std::shared_ptr< const Channel > lsst::gauss2d::fit::Channel::get_channel ( std::string name )

static

Get a channel with the given name, creating it if it doesn't exist

Parameters

name	The name of the channel to get

Returns

The Channel with the given name (created if non-existent)

make()

std::shared_ptr< Channel > lsst::gauss2d::fit::Channel::make ( std::string name )

static

Construct a new Channel

Parameters

name	The name of the Channel to create

Returns

The new Channel

---

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

• include/lsst/gauss2d/fit/channel.h
• src/channel.cc