Package org.rcsb.cif.model.generated

Class PdbxNmrSpectralDim

java.lang.Object

org.rcsb.cif.model.BaseCategory

org.rcsb.cif.model.generated.PdbxNmrSpectralDim

All Implemented Interfaces:

Category

@Generated("org.rcsb.cif.generator.SchemaGenerator")
public class PdbxNmrSpectralDim
extends BaseCategory

Items in the spectral_dim category describe the parameters of each dimension in the NMR experiment used to generate the spectral peak list.

Field Summary

Fields inherited from class org.rcsb.cif.model.BaseCategory

isText, textFields

Constructor Summary

Constructors

Constructor	Description
PdbxNmrSpectralDim(String name)
PdbxNmrSpectralDim(String name, int rowCount, Object[] encodedColumns)
PdbxNmrSpectralDim(String name, Map<String,Column> columns)

Method Summary

Modifier and Type	Method	Description
IntColumn	getAtomIsotopeNumber()	The mass number for the specified atom.
StrColumn	getAtomType()	The value for this tag is a standard IUPAC abbreviation for an element (i.e., H, C, N, P, etc).
FloatColumn	getCenterFrequencyOffset()	The center frequency offset for the spectral dimension specified.
IntColumn	getEncodedSourceDimensionId()	Pointer to '_pdbx_nmr_spectral_dim.id'.
StrColumn	getEncodingCode()	Code describing how information from one spectral dimension has been encoded in another dimension in for example a reduced dimensionality experiment.
StrColumn	getEntryId()	Pointer to '_entry.id'
IntColumn	getId()	An integer value that specifies the dimension of a multidimensional NMR spectrum.
IntColumn	getMagnetizationLinkageId()	The magnetization linkage ID is used to designate dimensions of a multidimensional NMR experiment where the nuclei observed in the dimensions are directly linked by a one bond scalar coupling.
IntColumn	getSpectralPeakListId()	Pointer to '_pdbx_nmr_spectral_peak_list.id'
StrColumn	getSpectralRegion()	A code defining the type of nuclei that would be expected to be observed in the spectral region observed in the dimension of the spectrum.
FloatColumn	getSweepWidth()	The width of the spectral window observed in Hz.
StrColumn	getSweepWidthUnits()	The units for the sweep width value (Hz or ppm)
StrColumn	getUnderSamplingType()	The type of spectral folding/aliasing that was used or occurred when the spectrum was collected.

Methods inherited from class org.rcsb.cif.model.BaseCategory

getBinaryColumn, getCategoryName, getColumn, getColumnNames, getRowCount, isDefined

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.rcsb.cif.model.Category

columnNames, columns, get

Constructor Detail

PdbxNmrSpectralDim

public PdbxNmrSpectralDim(String name,
                          Map<String,Column> columns)

PdbxNmrSpectralDim

public PdbxNmrSpectralDim(String name,
                          int rowCount,
                          Object[] encodedColumns)

PdbxNmrSpectralDim

public PdbxNmrSpectralDim(String name)

Method Detail

getId

public IntColumn getId()

An integer value that specifies the dimension of a multidimensional NMR spectrum.

Returns:

IntColumn

getAtomType

public StrColumn getAtomType()

The value for this tag is a standard IUPAC abbreviation for an element (i.e., H, C, N, P, etc).

Returns:

StrColumn

getAtomIsotopeNumber

public IntColumn getAtomIsotopeNumber()

The mass number for the specified atom.

Returns:

IntColumn

getSpectralRegion

public StrColumn getSpectralRegion()

A code defining the type of nuclei that would be expected to be observed in the spectral region observed in the dimension of the spectrum.

Returns:

StrColumn

getMagnetizationLinkageId

public IntColumn getMagnetizationLinkageId()

The magnetization linkage ID is used to designate dimensions of a multidimensional NMR experiment where the nuclei observed in the dimensions are directly linked by a one bond scalar coupling. For example, the amide proton and amide nitrogen in an 1H-15N HSQC experiment.

Returns:

IntColumn

getSweepWidth

public FloatColumn getSweepWidth()

The width of the spectral window observed in Hz.

Returns:

FloatColumn

getEncodingCode

public StrColumn getEncodingCode()

Code describing how information from one spectral dimension has been encoded in another dimension in for example a reduced dimensionality experiment.

Returns:

StrColumn

getEncodedSourceDimensionId

public IntColumn getEncodedSourceDimensionId()

Pointer to '_pdbx_nmr_spectral_dim.id'. The spectral dimension in a reduced dimensionality experiment that is the source of the magnetization that has been encoded.

Returns:

IntColumn

getEntryId

public StrColumn getEntryId()

Pointer to '_entry.id'

Returns:

StrColumn

getSpectralPeakListId

public IntColumn getSpectralPeakListId()

Pointer to '_pdbx_nmr_spectral_peak_list.id'

Returns:

IntColumn

getSweepWidthUnits

public StrColumn getSweepWidthUnits()

The units for the sweep width value (Hz or ppm)

Returns:

StrColumn

getCenterFrequencyOffset

public FloatColumn getCenterFrequencyOffset()

The center frequency offset for the spectral dimension specified.

Returns:

FloatColumn

getUnderSamplingType

public StrColumn getUnderSamplingType()

The type of spectral folding/aliasing that was used or occurred when the spectrum was collected.

Returns:

StrColumn