Class Bmrb

source code

Class containing methods related to BMRB STAR file reading and writing.

Instance Methods

[hide private]

str

_from_bmrb_model(self, name=None)
The model-free model name to BMRB name mapping.

source code

_sf_model_free_read(self, star, sample_conditions=None)
Fill the spin containers with the model-free data from the saveframe records.

source code

_sf_csa_read(self, star)
Place the CSA data from the saveframe records into the spin container.

source code

str

_to_bmrb_model(self, name=None)
Convert the model-free model name to the BMRB name.

source code

bmrb_read(self, file_path, version=None, sample_conditions=None)
Read the model-free results from a BMRB NMR-STAR v3.1 formatted file.

source code

bmrb_write(self, file_path, version=None)
Write the model-free results to a BMRB NMR-STAR v3.1 formatted file.

source code

Method Details

[hide private]

_from_bmrb_model(self, name=None)

source code

The model-free model name to BMRB name mapping.

Parameters:

name (str) - The BMRB model name.

Returns: str

The corresponding model-free model name.

_sf_model_free_read(self, star, sample_conditions=None)

source code

Fill the spin containers with the model-free data from the saveframe records.

Parameters:

star (NMR_STAR instance) - The NMR-STAR dictionary object.
sample_conditions (None or str) - The sample condition label to read. Only one sample condition can be read per data pipe.

_sf_csa_read(self, star)

source code

Place the CSA data from the saveframe records into the spin container.

Parameters:

star (NMR_STAR instance) - The NMR-STAR dictionary object.

_to_bmrb_model(self, name=None)

source code

Convert the model-free model name to the BMRB name.

Parameters:

name (str) - The model-free model name.

Returns: str

The corresponding BMRB model name.

bmrb_read(self, file_path, version=None, sample_conditions=None)

source code

Read the model-free results from a BMRB NMR-STAR v3.1 formatted file.

Parameters:

file_path (str) - The full file path.
version (None or str) - The BMRB version to force the reading.
sample_conditions (None or str) - The sample condition label to read. Only one sample condition can be read per data pipe.

bmrb_write(self, file_path, version=None)

source code

Write the model-free results to a BMRB NMR-STAR v3.1 formatted file.

Parameters:

file_path (str) - The full file path.
version (str) - The BMRB NMR-STAR dictionary format to output to.