Package org.rcsb.cif.schema.mm
Class IhmDerivedDistanceRestraint
java.lang.Object
org.rcsb.cif.schema.DelegatingCategory
org.rcsb.cif.schema.mm.IhmDerivedDistanceRestraint
- All Implemented Interfaces:
Category
@Generated("org.rcsb.cif.schema.generator.SchemaGenerator")
public class IhmDerivedDistanceRestraint
extends DelegatingCategory
Data items in the IHM_DERIVED_DISTANCE_RESTRAINT category records the
list of distance restraints used in the integrative modeling experiment.
These distance redistance restraints may be derived from various kinds of experiments.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.rcsb.cif.schema.DelegatingCategory
DelegatingCategory.DelegatingCifCoreCategoryNested classes/interfaces inherited from interface org.rcsb.cif.model.Category
Category.EmptyCategory -
Field Summary
-
Constructor Summary
Constructors Constructor Description IhmDerivedDistanceRestraint(Category delegate) -
Method Summary
Modifier and Type Method Description protected ColumncreateDelegate(String columnName, Column column)IntColumngetDatasetListId()Identifier to the input data from which the distance restraint is derived.FloatColumngetDistanceLowerLimit()The lower limit to the distance threshold applied to this distance restraint in the integrative modeling task.FloatColumngetDistanceLowerLimitEsd()The estimated standard deviation of the lower limit distance threshold applied to this distance restraint in the integrative modeling task.FloatColumngetDistanceThresholdEsd()The estimated standard deviation of the distance threshold applied to the restraint.FloatColumngetDistanceThresholdMean()The distance threshold mean applied to the restraint.FloatColumngetDistanceUpperLimit()The upper limit to the distance threshold applied to this distance restraint in the integrative modeling task.FloatColumngetDistanceUpperLimitEsd()The estimated standard deviation of the upper limit distance threshold applied to this distance restraint in the integrative modeling task.IntColumngetFeatureId1()The feature identifier for the first partner in the distance restraint.IntColumngetFeatureId2()The feature identifier for the second partner in the distance restraint.StrColumngetGroupConditionality()If a group of atoms or residues are restrained, this data item defines the conditionality based on which the restraint is applied in the modeling.IntColumngetGroupId()An identifier to group the distance restraints.IntColumngetId()A unique identifier for the derived distance restraint.FloatColumngetMicValue()The value of the Maximal Information Co-efficient (MIC), if applicable.FloatColumngetProbability()The real number that indicates the probability that the distance restraint is correct.FloatColumngetRandomExclusionFraction()The fraction of randomly excluded distance restraints during modeling.StrColumngetRestraintType()The type of distance restraint applied.Methods inherited from class org.rcsb.cif.schema.DelegatingCategory
getCategoryName, getColumn, getColumns, getRowCount
-
Constructor Details
-
Method Details
-
createDelegate
- Overrides:
createDelegatein classDelegatingCategory
-
getId
A unique identifier for the derived distance restraint.- Returns:
- IntColumn
-
getGroupId
An identifier to group the distance restraints. This can be the same as the _ihm_derived_distance_restraint.id in case the some of the restraints are not grouped.- Returns:
- IntColumn
-
getFeatureId1
The feature identifier for the first partner in the distance restraint. This data item is a pointer to _ihm_feature_list.feature_id in the IHM_FEATURE_LIST category.- Returns:
- IntColumn
-
getFeatureId2
The feature identifier for the second partner in the distance restraint. This data item is a pointer to _ihm_feature_list.feature_id in the IHM_FEATURE_LIST category.- Returns:
- IntColumn
-
getGroupConditionality
If a group of atoms or residues are restrained, this data item defines the conditionality based on which the restraint is applied in the modeling.- Returns:
- StrColumn
-
getRandomExclusionFraction
The fraction of randomly excluded distance restraints during modeling. In HADDOCK, this is used along with ambiguous interface restraints (AIRs) to account for uncertainties in AIRs.- Returns:
- FloatColumn
-
getDistanceLowerLimit
The lower limit to the distance threshold applied to this distance restraint in the integrative modeling task.- Returns:
- FloatColumn
-
getDistanceUpperLimit
The upper limit to the distance threshold applied to this distance restraint in the integrative modeling task.- Returns:
- FloatColumn
-
getDistanceLowerLimitEsd
The estimated standard deviation of the lower limit distance threshold applied to this distance restraint in the integrative modeling task.- Returns:
- FloatColumn
-
getDistanceUpperLimitEsd
The estimated standard deviation of the upper limit distance threshold applied to this distance restraint in the integrative modeling task.- Returns:
- FloatColumn
-
getProbability
The real number that indicates the probability that the distance restraint is correct. This number should fall between 0.0 and 1.0.- Returns:
- FloatColumn
-
getRestraintType
The type of distance restraint applied.- Returns:
- StrColumn
-
getMicValue
The value of the Maximal Information Co-efficient (MIC), if applicable. MIC values are correlation measures derived from the genetic profiles and are used to derive restraint information from quantitative measurements of genetic interactions.- Returns:
- FloatColumn
-
getDistanceThresholdMean
The distance threshold mean applied to the restraint.- Returns:
- FloatColumn
-
getDistanceThresholdEsd
The estimated standard deviation of the distance threshold applied to the restraint.- Returns:
- FloatColumn
-
getDatasetListId
Identifier to the input data from which the distance restraint is derived. This data item is a pointer to the _ihm_dataset_list.id in the IHM_DATASET_LIST category. This data item may not be applicable for all cases. For example, in case of ambiguous interface restraints where the interface residues are identified from multiple experiments, the reference to the _ihm_dataset_list.id is handled in the IHM_INTERFACE_RESIDUE_FEATURE category rather than here.- Returns:
- IntColumn
-