Package org.rcsb.cif.model.generated

Class Ihm3demRestraint

java.lang.Object

org.rcsb.cif.model.BaseCategory

org.rcsb.cif.model.generated.Ihm3demRestraint

All Implemented Interfaces:

Category

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

Data items in the IHM_3DEM_RESTRAINT category records the details of the 3DEM maps used as restraints in the IHM modeling.

Field Summary

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

isText, textFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
FloatColumn	getCrossCorrelationCoefficient()	The cross correlation coefficient corresponding to the model to map fitting.
IntColumn	getDatasetListId()	Identifier to the 3DEM map used.
StrColumn	getDetails()	Additional details regarding the model to map fitting.
StrColumn	getFittingMethod()	Method used to fit the model to the 3DEM map.
StrColumn	getFittingMethodCitationId()	The citation id of the citation for the fitting method used.
StrColumn	getMapSegmentFlag()	A flag that indicates whether or not the 3DEM map is segmented i.e., whether the whole map is used or only a portion of it is used (by masking or by other means) as restraint in the modeling.
IntColumn	getModelId()	The model number corresponding to the 3DEM fitting result presented.
IntColumn	getNumberOfGaussians()	In case of Gaussian mixture models, the number of gaussians is a parameter used to covert the 3DEM maps and models into GMMs.
IntColumn	getOrdinalId()	A unique identifier for the 3DEM restraint description.
IntColumn	getStructAssemblyId()	An indicator to whether the whole assembly that is modeled is fit into the 3DEM map or if only a subset of the structural assembly is fit into the map.

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

Ihm3demRestraint

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

Ihm3demRestraint

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

Ihm3demRestraint

public Ihm3demRestraint(String name)

Method Detail

getOrdinalId

public IntColumn getOrdinalId()

A unique identifier for the 3DEM restraint description.

Returns:

IntColumn

getDatasetListId

public IntColumn getDatasetListId()

Identifier to the 3DEM map used. This data item is a pointer to the _ihm_dataset_list.id in the IHM_DATASET_LIST category.

Returns:

IntColumn

getModelId

public IntColumn getModelId()

The model number corresponding to the 3DEM fitting result presented. This data item is a pointer to _ihm_model_list.model_id in the IHM_MODEL_LIST category.

Returns:

IntColumn

getStructAssemblyId

public IntColumn getStructAssemblyId()

An indicator to whether the whole assembly that is modeled is fit into the 3DEM map or if only a subset of the structural assembly is fit into the map. This data item is a pointer to _ihm_struct_assembly.assembly_id in the IHM_STRUCT_ASSEMBLY category. The IHM_STRUCT_ASSEMBLY category provides the details regarding the different structural assemblies used in the modeling. The default value for this data item is "1" indicating that the entire assembly being modeled is fit into the EM map.

Returns:

IntColumn

getFittingMethod

public StrColumn getFittingMethod()

Method used to fit the model to the 3DEM map.

Returns:

StrColumn

getNumberOfGaussians

public IntColumn getNumberOfGaussians()

In case of Gaussian mixture models, the number of gaussians is a parameter used to covert the 3DEM maps and models into GMMs. This captures the level of granularity used in representing the maps and/or models as 3D Gaussians.

Returns:

IntColumn

getMapSegmentFlag

public StrColumn getMapSegmentFlag()

A flag that indicates whether or not the 3DEM map is segmented i.e., whether the whole map is used or only a portion of it is used (by masking or by other means) as restraint in the modeling.

Returns:

StrColumn

getCrossCorrelationCoefficient

public FloatColumn getCrossCorrelationCoefficient()

The cross correlation coefficient corresponding to the model to map fitting.

Returns:

FloatColumn

getFittingMethodCitationId

public StrColumn getFittingMethodCitationId()

The citation id of the citation for the fitting method used. This data item is a pointer to _citation.id in the CITATION category.

Returns:

StrColumn

getDetails

public StrColumn getDetails()

Additional details regarding the model to map fitting.

Returns:

StrColumn