cphot::HDF5Library Class Reference

Storage of filters in HDF5 format. More...

#include <library.hpp>

Public Member Functions
	HDF5Library (const std::string &filename)
	Construct a new HDF5Library object. More...
std::vector< std::string >	get_content ()
	return the list of filters in the library More...
Filter	load_filter (const std::string &filter_name)
	Load a given filter from the library. More...
std::vector< std::string >	find (const std::string &name, bool case_sensitive=true)
	Look for filter names. More...
std::string	get_source ()
	Get the source filename of the library. More...

Detailed Description

Storage of filters in HDF5 format.

This is the format used by pyphot and thus one can use its file directly.

Definition at line 135 of file library.hpp.

Constructor & Destructor Documentation

HDF5Library()

cphot::HDF5Library::HDF5Library

(

const std::string &

filename

)

Construct a new HDF5Library object.

Parameters

filename

source filename of the HDF5 library

Definition at line 157 of file library.hpp.

Member Function Documentation

find()

std::vector< std::string > cphot::HDF5Library::find	(	const std::string &	name,
		bool	case_sensitive = true
	)

Look for filter names.

Parameters

name	name to look for
case_sensitive	set if the case needs to be respected (default true)

Returns

std::vector<std::string> list of potential candidates

Definition at line 191 of file library.hpp.

get_content()

std::vector< std::string > cphot::HDF5Library::get_content

(

)

return the list of filters in the library

Returns

std::vector<std::string>

Definition at line 170 of file library.hpp.

get_source()

std::string cphot::HDF5Library::get_source

(

)

Get the source filename of the library.

Returns

std::string filename

Definition at line 216 of file library.hpp.

load_filter()

Filter cphot::HDF5Library::load_filter

(

const std::string &

filter_name

)

Load a given filter from the library.

Parameters

filter_name

normalized names according to the library

Returns

Filter object

Definition at line 180 of file library.hpp.

---

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

• /home/runner/work/cphot/cphot/include/cphot/library.hpp