soma-io  5.1.2
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
soma::MultiFileFormat Class Reference

#include <soma-io/utilities/multifileformat.h>

Collaboration diagram for soma::MultiFileFormat:
Collaboration graph
[legend]

Public Member Functions

 MultiFileFormat ()
 
virtual ~MultiFileFormat ()
 

Static Public Member Functions

static MultiFileFormatInfo info (const std::string &filename)
 Get MultiFileFormatInfo to search files from a given filename. More...
 
static void updateInfo (MultiFileFormatInfo &info, carto::Object header, bool force_vol=false)
 Update MultiFileFormatInfo from .minf header info: More...
 
static void updateDimensions (const MultiFileFormatInfo &info, std::vector< int > &dims)
 Update dimensions using a MultiFileFormatInfo. More...
 
static std::string filename (const MultiFileFormatInfo &info, int32_t slice=-1, int32_t time=-1)
 Get formatted file name using a MultiFileFormatInfo. More...
 
static std::vector< std::string > filenames (const MultiFileFormatInfo &info)
 Get the filenames associated to a MultiFileFormatInfo. More...
 
static std::vector< std::string > filenames (const MultiFileFormatInfo &info, uint32_t slicemin, uint32_t slicemax, uint32_t timemin, uint32_t timemax)
 

Static Public Attributes

static const std::string FILENAME_SLICE_REGEX
 
static const std::string FILENAME_TIME_SLICE_REGEX
 
static const std::string FILENAME_TIME_REGEX
 

Detailed Description

Definition at line 65 of file multifileformat.h.

Constructor & Destructor Documentation

◆ MultiFileFormat()

soma::MultiFileFormat::MultiFileFormat ( )

◆ ~MultiFileFormat()

virtual soma::MultiFileFormat::~MultiFileFormat ( )
virtual

Member Function Documentation

◆ filename()

static std::string soma::MultiFileFormat::filename ( const MultiFileFormatInfo &  info,
int32_t  slice = -1,
int32_t  time = -1 
)
static

Get formatted file name using a MultiFileFormatInfo.

◆ filenames() [1/2]

static std::vector<std::string> soma::MultiFileFormat::filenames ( const MultiFileFormatInfo &  info)
static

Get the filenames associated to a MultiFileFormatInfo.

◆ filenames() [2/2]

static std::vector<std::string> soma::MultiFileFormat::filenames ( const MultiFileFormatInfo &  info,
uint32_t  slicemin,
uint32_t  slicemax,
uint32_t  timemin,
uint32_t  timemax 
)
static

◆ info()

static MultiFileFormatInfo soma::MultiFileFormat::info ( const std::string &  filename)
static

Get MultiFileFormatInfo to search files from a given filename.

◆ updateDimensions()

static void soma::MultiFileFormat::updateDimensions ( const MultiFileFormatInfo &  info,
std::vector< int > &  dims 
)
static

Update dimensions using a MultiFileFormatInfo.

◆ updateInfo()

static void soma::MultiFileFormat::updateInfo ( MultiFileFormatInfo &  info,
carto::Object  header,
bool  force_vol = false 
)
static

Update MultiFileFormatInfo from .minf header info:

Checks that the header has a list of files and that the input filename is in it, otherwise fallbacks to single file mode.

Member Data Documentation

◆ FILENAME_SLICE_REGEX

const std::string soma::MultiFileFormat::FILENAME_SLICE_REGEX
static

Definition at line 98 of file multifileformat.h.

◆ FILENAME_TIME_REGEX

const std::string soma::MultiFileFormat::FILENAME_TIME_REGEX
static

Definition at line 100 of file multifileformat.h.

◆ FILENAME_TIME_SLICE_REGEX

const std::string soma::MultiFileFormat::FILENAME_TIME_SLICE_REGEX
static

Definition at line 99 of file multifileformat.h.

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