Gemmi C++ API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
gemmi::Ccp4< T > Struct Template Reference

#include <ccp4.hpp>

Inheritance diagram for gemmi::Ccp4< T >:
[legend]

Public Member Functions

void prepare_ccp4_header_except_mode_and_stats ()
 
void update_ccp4_header (int mode=-1, bool update_stats=true)
 If the header is empty, prepare it; otherwise, update only MODE and, if update_stats==true, also DMIN, DMAX, DMEAN and RMS.
 
bool full_cell () const
 
template<typename Stream >
void read_ccp4_header (Stream &f, const std::string &path)
 
void setup (T default_value, MapSetup mode=MapSetup::Full)
 
void set_extent (const Box< Fractional > &box)
 
template<typename Stream >
void read_ccp4_stream (Stream f, const std::string &path)
 
void read_ccp4_file (const std::string &path)
 
void read_ccp4_from_memory (const char *data, size_t size, const std::string &name)
 
template<typename Input >
void read_ccp4 (Input &&input)
 
void write_ccp4_map (const std::string &path) const
 
- Public Member Functions inherited from gemmi::Ccp4Base
voidheader_word (int w)
 
const voidheader_word (int w) const
 
int32_t header_i32 (int w) const
 
std::array< int, 3 > header_3i32 (int w) const
 
float header_float (int w) const
 
std::string header_str (int w, size_t len=80) const
 
void set_header_i32 (int w, int32_t value)
 
void set_header_3i32 (int w, int32_t x, int32_t y, int32_t z)
 
void set_header_float (int w, float value)
 
void set_header_str (int w, const std::string &str)
 
std::array< int, 3 > axis_positions () const
 
double header_rfloat (int w) const
 
Box< Fractionalget_extent () const
 
bool has_skew_transformation () const
 
Transform get_skew_transformation () const
 
Position get_origin () const
 

Static Public Member Functions

static int mode_for_data ()
 

Public Attributes

Grid< Tgrid
 
- Public Attributes inherited from gemmi::Ccp4Base
DataStats hstats
 
std::vector< int32_t > ccp4_header
 
bool same_byte_order = true
 

Detailed Description

template<typename T = float>
struct gemmi::Ccp4< T >

Definition at line 143 of file ccp4.hpp.

Member Function Documentation

◆ prepare_ccp4_header_except_mode_and_stats()

template<typename T = float>
void gemmi::Ccp4< T >::prepare_ccp4_header_except_mode_and_stats ( )
inline

Definition at line 147 of file ccp4.hpp.

◆ update_ccp4_header()

template<typename T = float>
void gemmi::Ccp4< T >::update_ccp4_header ( int  mode = -1,
bool  update_stats = true 
)
inline

If the header is empty, prepare it; otherwise, update only MODE and, if update_stats==true, also DMIN, DMAX, DMEAN and RMS.

Definition at line 187 of file ccp4.hpp.

◆ mode_for_data()

template<typename T = float>
static int gemmi::Ccp4< T >::mode_for_data ( )
inlinestatic

Definition at line 212 of file ccp4.hpp.

◆ full_cell()

template<typename T = float>
bool gemmi::Ccp4< T >::full_cell ( ) const
inline

Definition at line 224 of file ccp4.hpp.

◆ read_ccp4_header()

template<typename T = float>
template<typename Stream >
void gemmi::Ccp4< T >::read_ccp4_header ( Stream f,
const std::string &  path 
)
inline

Definition at line 235 of file ccp4.hpp.

◆ setup()

template<typename T >
void gemmi::Ccp4< T >::setup ( T  default_value,
MapSetup  mode = MapSetup::Full 
)

Definition at line 388 of file ccp4.hpp.

◆ set_extent()

template<typename T >
void gemmi::Ccp4< T >::set_extent ( const Box< Fractional > &  box)

Definition at line 444 of file ccp4.hpp.

◆ read_ccp4_stream()

template<typename T >
template<typename Stream >
void gemmi::Ccp4< T >::read_ccp4_stream ( Stream  f,
const std::string &  path 
)

Definition at line 359 of file ccp4.hpp.

◆ read_ccp4_file()

template<typename T = float>
void gemmi::Ccp4< T >::read_ccp4_file ( const std::string &  path)
inline

Definition at line 284 of file ccp4.hpp.

◆ read_ccp4_from_memory()

template<typename T = float>
void gemmi::Ccp4< T >::read_ccp4_from_memory ( const char data,
size_t  size,
const std::string &  name 
)
inline

Definition at line 289 of file ccp4.hpp.

◆ read_ccp4()

template<typename T = float>
template<typename Input >
void gemmi::Ccp4< T >::read_ccp4 ( Input &&  input)
inline

Definition at line 295 of file ccp4.hpp.

◆ write_ccp4_map()

template<typename T >
void gemmi::Ccp4< T >::write_ccp4_map ( const std::string &  path) const

Definition at line 472 of file ccp4.hpp.

Member Data Documentation

◆ grid

template<typename T = float>
Grid<T> gemmi::Ccp4< T >::grid

Definition at line 144 of file ccp4.hpp.


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