#include <occ_describe.h>
|
| bool | writes_records () const |
| | Whether RINSE records are written to a file, which restricts the run to RINSE and makes a structure that fails a record rather than an error.
|
| std::vector< Descriptor > | descriptors () const |
|
| std::vector< std::string > | structure_filenames {} |
| | Structure files to describe, each handled according to its extension: xyz for molecules, cif or res/ins for crystals.
|
| std::vector< std::string > | descriptor_strings {} |
| int | hash_words {1} |
| | Words in the RINSE hash; each carries 16 bits.
|
| std::optional< double > | fixed_uiso {} |
| | Isotropic U, in A^2, given to every atom in place of its ADPs for RINSE.
|
| std::string | json_filename {} |
| | Write the RINSE records to this file as one JSON document.
|
| std::string | jsonl_filename {} |
| | Stream the RINSE records to this file as JSON Lines: a header line, then one line per structure as it is described.
|
◆ Descriptor
| Enumerator |
|---|
| Steinhardt | |
| Rinse | |
◆ descriptors()
| std::vector< Descriptor > occ::main::DescribeConfig::descriptors |
( |
| ) |
const |
◆ writes_records()
| bool occ::main::DescribeConfig::writes_records |
( |
| ) |
const |
|
inline |
Whether RINSE records are written to a file, which restricts the run to RINSE and makes a structure that fails a record rather than an error.
◆ descriptor_strings
| std::vector<std::string> occ::main::DescribeConfig::descriptor_strings {} |
◆ fixed_uiso
| std::optional<double> occ::main::DescribeConfig::fixed_uiso {} |
Isotropic U, in A^2, given to every atom in place of its ADPs for RINSE.
◆ hash_words
| int occ::main::DescribeConfig::hash_words {1} |
Words in the RINSE hash; each carries 16 bits.
◆ json_filename
| std::string occ::main::DescribeConfig::json_filename {} |
Write the RINSE records to this file as one JSON document.
◆ jsonl_filename
| std::string occ::main::DescribeConfig::jsonl_filename {} |
Stream the RINSE records to this file as JSON Lines: a header line, then one line per structure as it is described.
◆ structure_filenames
| std::vector<std::string> occ::main::DescribeConfig::structure_filenames {} |
Structure files to describe, each handled according to its extension: xyz for molecules, cif or res/ins for crystals.
The documentation for this struct was generated from the following file: