module

Chem::AtomCollection

Instance methods

atoms
Source
bonds
Source
coords
Source
coords=(coords : Enumerable(Spatial::Vec3)) : Enumerable(Spatial::Vec3)

Sets the atom coordinates.

Source
each_atom
Source
each_atom
Source
each_fragment
Source
formal_charge
Source
formal_charges
Source
fragments
Source
has_hydrogens?
Source
n_atoms
Source
to_gen(fractional : Bool = false) : String

Returns a string representation of the atom collection using the Chem::Gen file format. Arguments are fowarded to Chem::Gen::Writer.open.

Source
to_gen(output : IO | Path | String, fractional : Bool = false) : Nil

Writes the atom collection to output using the Chem::Gen file format. Arguments are fowarded to Chem::Gen::Writer.open.

Source
to_mol2(output : IO | Path | String) : Nil

Writes the atom collection to output using the Chem::Mol2 file format. Arguments are fowarded to Chem::Mol2::Writer.open.

Source
to_mol2

Returns a string representation of the atom collection using the Chem::Mol2 file format. Arguments are fowarded to Chem::Mol2::Writer.open.

Source
to_pdb(bonds : Chem::PDB::Writer::BondOptions = Chem::PDB::Writer::BondOptions.flags(Het, Disulfide), renumber : Bool = true, ter_on_fragment : Bool = false) : String

Returns a string representation of the atom collection using the Chem::PDB file format. Arguments are fowarded to Chem::PDB::Writer.open.

Source
to_pdb(output : IO | Path | String, bonds : Chem::PDB::Writer::BondOptions = Chem::PDB::Writer::BondOptions.flags(Het, Disulfide), renumber : Bool = true, ter_on_fragment : Bool = false) : Nil

Writes the atom collection to output using the Chem::PDB file format. Arguments are fowarded to Chem::PDB::Writer.open.

Source
to_xyz(extended : Bool = false, fields : Array(String) = [] of String) : String

Returns a string representation of the atom collection using the Chem::XYZ file format. Arguments are fowarded to Chem::XYZ::Writer.open.

Source
to_xyz(output : IO | Path | String, extended : Bool = false, fields : Array(String) = [] of String) : Nil

Writes the atom collection to output using the Chem::XYZ file format. Arguments are fowarded to Chem::XYZ::Writer.open.

Source
write(output : IO | Path | String, format : Chem::Format | String) : Nil

Writes the atom collection to output using format. Raises ArgumentError if format has required arguments or cannot write Chem::AtomCollection.

The supported file formats are Chem::Gen, Chem::Mol2, Chem::PDB, Chem::XYZ. Use the #to_* methods to customize how the object is written in the corresponding file format if possible.

Source
write(path : Path | String) : Nil

Writes the atom collection to the specified file. The file format is chosen based on the filename (see Chem::Format#from_filename). Raises ArgumentError if the file format cannot be determined.

The supported file formats are the following:

  • Chem::Gen (.gen)
  • Chem::Mol2 (.mol2)
  • Chem::PDB (.ent, .pdb)
  • Chem::XYZ (.xyz)

Use the #to_* methods to customize how the object is written in the corresponding file format if possible.

Source