bmrblib.kinetics.heteronucl_T1_relaxation_v3

1 ############################################################################# 2 # # 3 # The BMRB library. # 4 # # 5 # Copyright (C) 2009-2011 Edward d'Auvergne # 6 # # 7 # This program is free software: you can redistribute it and/or modify # 8 # it under the terms of the GNU General Public License as published by # 9 # the Free Software Foundation, either version 3 of the License, or # 10 # (at your option) any later version. # 11 # # 12 # This program is distributed in the hope that it will be useful, # 13 # but WITHOUT ANY WARRANTY; without even the implied warranty of # 14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # 15 # GNU General Public License for more details. # 16 # # 17 # You should have received a copy of the GNU General Public License # 18 # along with this program. If not, see <http://www.gnu.org/licenses/>. # 19 # # 20 ############################################################################# 21 22 # Module docstring. 23 """The v3.1 Heteronuclear T1 data saveframe category. 24 25 See http://www.bmrb.wisc.edu/dictionary/3.1html/SaveFramePage.html#heteronucl_T1_relaxation. 26 """ 27 28 # relax module imports. 29 from bmrblib.kinetics.heteronucl_T1_relaxation import HeteronuclT1Saveframe, HeteronuclT1List, HeteronuclT1Experiment, HeteronuclT1Software, T1 30 31

32 -class HeteronuclT1Saveframe_v3_1(HeteronuclT1Saveframe):

33 """The v3.1 Heteronuclear T1 data saveframe class.""" 34 35 # Class variables. 36 name = 'T1' 37 label = 'heteronucl_T1' 38 sf_label = 'heteronucl_T1_relaxation' 39

40 - def add_tag_categories(self):

41 """Create the v3.1 tag categories.""" 42 43 # The tag category objects. 44 self.tag_categories.append(HeteronuclT1List_v3_1(self)) 45 self.tag_categories.append(HeteronuclT1Experiment_v3_1(self)) 46 self.tag_categories.append(HeteronuclT1Software_v3_1(self)) 47 self.tag_categories.append(T1_v3_1(self))

48 49 50

51 -class HeteronuclT1List_v3_1(HeteronuclT1List):

52 """v3.1 HeteronuclT1List tag category.""" 53

54 - def __init__(self, sf):

55 """Setup the HeteronuclT1List_v3_1 tag category. 56 57 @param sf: The saveframe object. 58 @type sf: saveframe instance 59 """ 60 61 # Initialise the baseclass. 62 super(HeteronuclT1List_v3_1, self).__init__(sf) 63 64 # The category name. 65 self.tag_category_label = 'Heteronucl_T1_list' 66 67 # Change tag names. 68 self['SfCategory'].tag_name = 'Sf_category' 69 self['SfFramecode'].tag_name = 'Sf_framecode' 70 self['HeteronuclT1ListID'].tag_name = 'ID' 71 self['DataFileName'].tag_name = 'Data_file_name' 72 self['SampleConditionListID'].tag_name = 'Sample_condition_list_ID' 73 self['SampleConditionListLabel'].tag_name = 'Sample_condition_list_label' 74 self['SpectrometerFrequency1H'].tag_name = 'Spectrometer_frequency_1H' 75 self['T1CoherenceType'].tag_name = 'T1_coherence_type' 76 self['T1ValUnits'].tag_name = 'T1_val_units' 77 self['Details'].tag_name = 'Details' 78 self['TextDataFormat'].tag_name = 'Text_data_format' 79 self['TextData'].tag_name = 'Text_data'

80 81 82

83 -class HeteronuclT1Experiment_v3_1(HeteronuclT1Experiment):

84 """v3.1 HeteronuclT1Experiment tag category.""" 85

86 - def __init__(self, sf):

87 """Setup the HeteronuclT1Experiment_v3_1 tag category. 88 89 @param sf: The saveframe object. 90 @type sf: saveframe instance 91 """ 92 93 # Initialise the baseclass. 94 super(HeteronuclT1Experiment_v3_1, self).__init__(sf) 95 96 # The category name. 97 self.tag_category_label = 'Heteronucl_T1_experiment' 98 99 # Change tag names. 100 self['ExperimentID'].tag_name = 'Experiment_ID' 101 self['ExperimentName'].tag_name = 'Experiment_name' 102 self['SampleID'].tag_name = 'Sample_ID' 103 self['SampleLabel'].tag_name = 'Sample_label' 104 self['SampleState'].tag_name = 'Sample_state' 105 self['EntryID'].tag_name = 'Entry_ID' 106 self['HeteronuclT1ListID'].tag_name = 'Heteronucl_T1_list_ID'

107 108 109

110 -class HeteronuclT1Software_v3_1(HeteronuclT1Software):

111 """v3.1 HeteronuclT1Software tag category.""" 112

113 - def __init__(self, sf):

114 """Setup the HeteronuclT1Software_v3_1 tag category. 115 116 @param sf: The saveframe object. 117 @type sf: saveframe instance 118 """ 119 120 # Initialise the baseclass. 121 super(HeteronuclT1Software_v3_1, self).__init__(sf) 122 123 # The category name. 124 self.tag_category_label = 'Heteronucl_T1_software' 125 126 # Change tag names. 127 self['SoftwareID'].tag_name = 'Software_ID' 128 self['SoftwareLabel'].tag_name = 'Software_label' 129 self['MethodID'].tag_name = 'Method_ID' 130 self['MethodLabel'].tag_name = 'Method_label' 131 self['EntryID'].tag_name = 'Entry_ID' 132 self['HeteronuclT1ListID'].tag_name = 'Heteronucl_T1_list_ID'

133 134 135

136 -class T1_v3_1(T1):

137 """v3.1 T1 tag category.""" 138

139 - def __init__(self, sf):

140 """Setup the T1_v3_1 tag category. 141 142 @param sf: The saveframe object. 143 @type sf: saveframe instance 144 """ 145 146 # Initialise the baseclass. 147 super(T1_v3_1, self).__init__(sf) 148 149 # The category name. 150 self.tag_category_label = 'T1' 151 152 # Change tag names. 153 self['RxID'].tag_name = 'ID' 154 self['AssemblyAtomID'].tag_name = 'Assembly_atom_ID' 155 self['EntityAssemblyID'].tag_name = 'Entity_assembly_ID' 156 self['EntityID'].tag_name = 'Entity_ID' 157 self['CompIndexID'].tag_name = 'Comp_index_ID' 158 self['SeqID'].tag_name = 'Seq_ID' 159 self['CompID'].tag_name = 'Comp_ID' 160 self['AtomID'].tag_name = 'Atom_ID' 161 self['AtomType'].tag_name = 'Atom_type' 162 self['AtomIsotopeNumber'].tag_name = 'Atom_isotope_number' 163 self['Val'].tag_name = 'Val' 164 self['ValErr'].tag_name = 'Val_err' 165 self['ResonanceID'].tag_name = 'Resonance_ID' 166 self['AuthEntityAssemblyID'].tag_name = 'Auth_entity_assembly_ID' 167 self['AuthSeqID'].tag_name = 'Auth_seq_ID' 168 self['AuthCompID'].tag_name = 'Auth_comp_ID' 169 self['AuthAtomID'].tag_name = 'Auth_atom_ID' 170 self['EntryID'].tag_name = 'Entry_ID' 171 self['HeteronuclT1ListID'].tag_name = 'Heteronucl_T1_list_ID'

172

Source Code for Module bmrblib.kinetics.heteronucl_T1_relaxation_v3_1