Package rosetta :: Package core :: Package fragment :: Module _core_fragment_ :: Class ConstantLengthFragSet
[hide private]
[frames] | no frames]

Class ConstantLengthFragSet

 object --+        
          |        
??.instance --+    
              |    
        FragSet --+
                  |
                 ConstantLengthFragSet

A set of fragments that contains fragments of a constant length read
in from a fragment file.
this object is a simple implementation of the FragSet
for custom fragments, check out https://robetta.bakerlab.org/fragmentsubmit.jsp
example:
    ninemers = ConstantLengthFragSet(9)
    ninemers.read_fragment_file("test9_fragments")
See also:
    Pose
    ClassicFragmentMover

Instance Methods [hide private]
 
__init__(...)
__init__( (object)arg1, (int)frag_length) -> None : core/fragment/ConstantLengthFragSet.hh:71
 
begin(...)
begin( (ConstantLengthFragSet)arg1) -> ConstFrameIterator : iterate over contents
 
clone(...)
clone( (ConstantLengthFragSet)arg1) -> FragSet : core/fragment/ConstantLengthFragSet.hh:83
 
empty(...)
empty( (ConstantLengthFragSet)arg1) -> bool : core/fragment/ConstantLengthFragSet.hh:146
 
empty_clone(...)
empty_clone( (ConstantLengthFragSet)arg1) -> FragSet : core/fragment/ConstantLengthFragSet.hh:88
 
end(...)
end( (ConstantLengthFragSet)arg1) -> ConstFrameIterator : core/fragment/ConstantLengthFragSet.hh:140
 
nonconst_begin(...)
nonconst_begin( (ConstantLengthFragSet)arg1) -> FrameIterator : core/fragment/ConstantLengthFragSet.hh:143
 
nonconst_end(...)
nonconst_end( (ConstantLengthFragSet)arg1) -> FrameIterator : core/fragment/ConstantLengthFragSet.hh:144
 
overlapping_with_region(...)
overlapping_with_region( (ConstantLengthFragSet)arg1, (MoveMap)mm, (int)start, (int)end, (int)min_overlap, (int)min_length, (FrameList)frames) -> int : returns the number and list of all fragment alignment frames that somehow overlap with the given region (also allows those frames that start before the region and reach into it)
 
read_fragment_file(...)
read_fragment_file( (ConstantLengthFragSet)arg1, (str)filename [, (int)top25=0 [, (int)ncopies=1 [, (bool)bAnnotation=False]]]) -> None : Loads the contents of <filename> into the ConstantLengthFragSet example: ninemers.read_fragment_file("test9_fragments") See also: ConstantLengthFragSet Pose Pose.omega Pose.phi Pose.psi ClassicFragmentMover
 
read_fragment_stream(...)
read_fragment_stream( (ConstantLengthFragSet)arg1, (object)data [, (int)top25=0 [, (int)ncopies=1 [, (bool)bAnnotation=False]]]) -> None : core/fragment/ConstantLengthFragSet.hh:106
 
region(...)
region( (ConstantLengthFragSet)arg1, (MoveMap)mm, (int)start, (int)end, (int), (int), (FrameList)frames) -> int : there is only one Frame per position, end / max_overlap are ignored

Inherited from FragSet: __reduce__, __str__, add, clone_shifted, frames, generate_insert_map, global_offset, insert_fragID_list, max_frag_length, max_pos, min_pos, nr_frames, region_all, region_simple, shift_by, size

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Variables [hide private]
  __instance_size__ = 32
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

 

__init__( (object)arg1, (int)frag_length) -> None :
    core/fragment/ConstantLengthFragSet.hh:71

    C++ signature :
        void __init__(_object*,unsigned long)

__init__( (object)arg1, (ConstantLengthFragSet)) -> None :
    A set of fragments that contains fragments of a constant length read
    in from a fragment file.
    this object is a simple implementation of the FragSet
    for custom fragments, check out https://robetta.bakerlab.org/fragmentsubmit.jsp
    example:
        ninemers = ConstantLengthFragSet(9)
        ninemers.read_fragment_file("test9_fragments")
    See also:
        Pose
        ClassicFragmentMover
    

    C++ signature :
        void __init__(_object*,core::fragment::ConstantLengthFragSet)

__init__( (object)arg1, (int)frag_length, (str)filename) -> None :
    core/fragment/ConstantLengthFragSet.hh:75

    C++ signature :
        void __init__(_object*,unsigned long,std::string)

__init__( (object)arg1) -> None :

    C++ signature :
        void __init__(_object*)

__init__( (object)arg1, (FragSet)fragments) -> None :
    core/fragment/ConstantLengthFragSet.hh:81

    C++ signature :
        void __init__(_object*,core::fragment::FragSet)

Overrides: object.__init__

begin(...)

 

begin( (ConstantLengthFragSet)arg1) -> ConstFrameIterator :
    iterate over contents
    

    C++ signature :
        core::fragment::ConstFrameIterator begin(core::fragment::ConstantLengthFragSet {lvalue})

Overrides: FragSet.begin

clone(...)

 

clone( (ConstantLengthFragSet)arg1) -> FragSet :
    core/fragment/ConstantLengthFragSet.hh:83

    C++ signature :
        boost::shared_ptr<core::fragment::FragSet> clone(core::fragment::ConstantLengthFragSet {lvalue})

Overrides: FragSet.clone

empty(...)

 

empty( (ConstantLengthFragSet)arg1) -> bool :
    core/fragment/ConstantLengthFragSet.hh:146

    C++ signature :
        bool empty(core::fragment::ConstantLengthFragSet {lvalue})

Overrides: FragSet.empty

empty_clone(...)

 

empty_clone( (ConstantLengthFragSet)arg1) -> FragSet :
    core/fragment/ConstantLengthFragSet.hh:88

    C++ signature :
        boost::shared_ptr<core::fragment::FragSet> empty_clone(core::fragment::ConstantLengthFragSet {lvalue})

Overrides: FragSet.empty_clone

end(...)

 

end( (ConstantLengthFragSet)arg1) -> ConstFrameIterator :
    core/fragment/ConstantLengthFragSet.hh:140

    C++ signature :
        core::fragment::ConstFrameIterator end(core::fragment::ConstantLengthFragSet {lvalue})

Overrides: FragSet.end

nonconst_begin(...)

 

nonconst_begin( (ConstantLengthFragSet)arg1) -> FrameIterator :
    core/fragment/ConstantLengthFragSet.hh:143

    C++ signature :
        core::fragment::FrameIterator nonconst_begin(core::fragment::ConstantLengthFragSet {lvalue})

Overrides: FragSet.nonconst_begin

nonconst_end(...)

 

nonconst_end( (ConstantLengthFragSet)arg1) -> FrameIterator :
    core/fragment/ConstantLengthFragSet.hh:144

    C++ signature :
        core::fragment::FrameIterator nonconst_end(core::fragment::ConstantLengthFragSet {lvalue})

Overrides: FragSet.nonconst_end

overlapping_with_region(...)

 

overlapping_with_region( (ConstantLengthFragSet)arg1, (MoveMap)mm, (int)start, (int)end, (int)min_overlap, (int)min_length, (FrameList)frames) -> int :
    returns the number and list of all fragment alignment frames that somehow overlap with the given region
    (also allows those frames that start before the region and reach into it)
    

    C++ signature :
        unsigned long overlapping_with_region(core::fragment::ConstantLengthFragSet {lvalue},core::kinematics::MoveMap,unsigned long,unsigned long,unsigned long,unsigned long,core::fragment::FrameList {lvalue})

Overrides: FragSet.overlapping_with_region

read_fragment_file(...)

 

read_fragment_file( (ConstantLengthFragSet)arg1, (str)filename [, (int)top25=0 [, (int)ncopies=1 [, (bool)bAnnotation=False]]]) -> None :
    Loads the contents of  <filename>  into the ConstantLengthFragSet
    example:
        ninemers.read_fragment_file("test9_fragments")
    See also:
        ConstantLengthFragSet
        Pose
        Pose.omega
        Pose.phi
        Pose.psi
        ClassicFragmentMover
    

    C++ signature :
        void read_fragment_file(core::fragment::ConstantLengthFragSet {lvalue},std::string [,unsigned long=0 [,unsigned long=1 [,bool=False]]])

read_fragment_stream(...)

 

read_fragment_stream( (ConstantLengthFragSet)arg1, (object)data [, (int)top25=0 [, (int)ncopies=1 [, (bool)bAnnotation=False]]]) -> None :
    core/fragment/ConstantLengthFragSet.hh:106

    C++ signature :
        void read_fragment_stream(core::fragment::ConstantLengthFragSet {lvalue},utility::io::izstream {lvalue} [,unsigned long=0 [,unsigned long=1 [,bool=False]]])

region(...)

 

region( (ConstantLengthFragSet)arg1, (MoveMap)mm, (int)start, (int)end, (int), (int), (FrameList)frames) -> int :
    there is only one Frame per position, end / max_overlap are ignored
    

    C++ signature :
        unsigned long region(core::fragment::ConstantLengthFragSet {lvalue},core::kinematics::MoveMap,unsigned long,unsigned long,unsigned long,unsigned long,core::fragment::FrameList {lvalue})

Overrides: FragSet.region