<!-- https://docs.dseams.info/reference/lua-api.md -->

# Lua {#lua}

Names registered on `require("dseams")` in [yodaStruct](https://github.com/d-SEAMS/yodaStruct). Each entry is a `set_function` name. The C column lists `seams_*` calls in that function when the binding reaches `seams.h` directly.

## Native API {#native-api}

Generated from the sources named below. A name on this page is a public call in that language.

### dseams.averageQ6 {#dseams-averageq6}

```lua
averageQ6
```

### dseams.bondClassifierNames {#dseams-bondclassifiernames}

```lua
bondClassifierNames
```

### dseams.bondNetworkByIndex {#dseams-bondnetworkbyindex}

```lua
bondNetworkByIndex
```

### dseams.bulkRingNumberAnalysis {#dseams-bulkringnumberanalysis}

```lua
bulkRingNumberAnalysis
```

### dseams.bulkTopoUnitMatching {#dseams-bulktopounitmatching}

```lua
bulkTopoUnitMatching
```

### dseams.bulkTopologicalNetworkCriterion {#dseams-bulktopologicalnetworkcriterion}

```lua
bulkTopologicalNetworkCriterion
```

### dseams.cageAffiliation {#dseams-cageaffiliation}

```lua
cageAffiliation
```

### dseams.calcCN {#dseams-calccn}

```lua
calcCN
```

### dseams.calcRDF {#dseams-calcrdf}

```lua
calcRDF
```

### dseams.calcRDF3D {#dseams-calcrdf3d}

```lua
calcRDF3D
```

### dseams.calcRunningCN {#dseams-calcrunningcn}

```lua
calcRunningCN
```

### dseams.chillPlus_cij {#dseams-chillplus-cij}

```lua
chillPlus_cij
```

### dseams.chillPlus_iceType {#dseams-chillplus-icetype}

```lua
chillPlus_iceType
```

### dseams.chill_cij {#dseams-chill-cij}

```lua
chill_cij
```

### dseams.chill_iceType {#dseams-chill-icetype}

```lua
chill_iceType
```

### dseams.classifyBonds {#dseams-classifybonds}

```lua
classifyBonds
```

### dseams.classifyTemplates {#dseams-classifytemplates}

```lua
classifyTemplates
```

### dseams.classifyTopology {#dseams-classifytopology}

```lua
classifyTopology
```

### dseams.clusterAnalysis {#dseams-clusteranalysis}

```lua
clusterAnalysis
```

### dseams.contactPairs {#dseams-contactpairs}

```lua
contactPairs
```

### dseams.densityByKind {#dseams-densitybykind}

```lua
densityByKind
```

### dseams.densityByType {#dseams-densitybytype}

```lua
densityByType
```

### dseams.domainStats {#dseams-domainstats}

```lua
domainStats
```

### dseams.donatedHydrogenBond {#dseams-donatedhydrogenbond}

```lua
donatedHydrogenBond
```

### dseams.findBySignature {#dseams-findbysignature}

```lua
findBySignature
```

### dseams.getCorrel {#dseams-getcorrel}

```lua
getCorrel
```

### dseams.getCorrelPlus {#dseams-getcorrelplus}

```lua
getCorrelPlus
```

### dseams.getHbondNetwork {#dseams-gethbondnetwork}

```lua
getHbondNetwork
```

### dseams.getHbondNetworkFromClouds {#dseams-gethbondnetworkfromclouds}

```lua
getHbondNetworkFromClouds
```

### dseams.getHbondNetworkFromDonors {#dseams-gethbondnetworkfromdonors}

```lua
getHbondNetworkFromDonors
```

### dseams.getIceType {#dseams-geticetype}

```lua
getIceType
```

### dseams.getIceTypeNoPrint {#dseams-geticetypenoprint}

```lua
getIceTypeNoPrint
```

### dseams.getIceTypePlus {#dseams-geticetypeplus}

```lua
getIceTypePlus
```

### dseams.getIceTypePlusNoPrint {#dseams-geticetypeplusnoprint}

```lua
getIceTypePlusNoPrint
```

### dseams.getNewNeighbourListByIndex {#dseams-getnewneighbourlistbyindex}

```lua
getNewNeighbourListByIndex
```

### dseams.getPointCloudAtomsOfOneAtomType {#dseams-getpointcloudatomsofoneatomtype}

```lua
getPointCloudAtomsOfOneAtomType
```

### dseams.getPrimitiveRings {#dseams-getprimitiverings}

```lua
getPrimitiveRings
```

### dseams.guestOccupancy {#dseams-guestoccupancy}

```lua
guestOccupancy
```

### dseams.indicesOf {#dseams-indicesof}

```lua
indicesOf
```

### dseams.ionCloud {#dseams-ioncloud}

```lua
ionCloud
```

### dseams.ionEnvironment {#dseams-ionenvironment}

```lua
ionEnvironment
```

### dseams.kNearestNeighbourList {#dseams-knearestneighbourlist}

```lua
kNearestNeighbourList
```

### dseams.kNearestNeighbourPair {#dseams-knearestneighbourpair}

```lua
kNearestNeighbourPair
```

### dseams.localTopologyKey {#dseams-localtopologykey}

```lua
localTopologyKey
```

### dseams.modifyChill {#dseams-modifychill}

```lua
modifyChill
```

### dseams.mutualNearestUnlike {#dseams-mutualnearestunlike}

```lua
mutualNearestUnlike
```

### dseams.neighListO {#dseams-neighlisto}

```lua
neighListO
```

### dseams.neighListPair {#dseams-neighlistpair}

```lua
neighListPair
```

### dseams.neighborList {#dseams-neighborlist}

```lua
neighborList
```

### dseams.neighbourListByIndex {#dseams-neighbourlistbyindex}

```lua
neighbourListByIndex
```

### dseams.parseSiteSpec {#dseams-parsesitespec}

```lua
parseSiteSpec
```

### dseams.percentage_Ice {#dseams-percentage-ice}

```lua
percentage_Ice
```

### dseams.periodicCentroid {#dseams-periodiccentroid}

```lua
periodicCentroid
```

### dseams.prismAnalysis {#dseams-prismanalysis}

```lua
prismAnalysis
```

### dseams.readChemfiles {#dseams-readchemfiles}

```lua
readChemfiles
```

### dseams.readCon {#dseams-readcon}

```lua
readCon
```

### dseams.readFrame {#dseams-readframe}

```lua
readFrame
```

### dseams.readFrameOnlyOne {#dseams-readframeonlyone}

```lua
readFrameOnlyOne
```

### dseams.readFrameOnlyOneAllAtoms {#dseams-readframeonlyoneallatoms}

```lua
readFrameOnlyOneAllAtoms
```

### dseams.readLammpsTrj {#dseams-readlammpstrj}

```lua
readLammpsTrj
```

### dseams.readLammpsTrjO {#dseams-readlammpstrjo}

```lua
readLammpsTrjO
```

### dseams.readLammpsTrjreduced {#dseams-readlammpstrjreduced}

```lua
readLammpsTrjreduced
```

### dseams.readXYZ {#dseams-readxyz}

```lua
readXYZ
```

### dseams.recenterCluster {#dseams-recentercluster}

```lua
recenterCluster
```

### dseams.registerBondClassifier {#dseams-registerbondclassifier}

```lua
registerBondClassifier
```

### dseams.ringAnalysis {#dseams-ringanalysis}

```lua
ringAnalysis
```

### dseams.ringNetwork {#dseams-ringnetwork}

```lua
ringNetwork
```

### dseams.seededCageAffiliation {#dseams-seededcageaffiliation}

```lua
seededCageAffiliation
```

### dseams.selectAtomsInSliceWithRingEdgeAtoms {#dseams-selectatomsinslicewithringedgeatoms}

```lua
selectAtomsInSliceWithRingEdgeAtoms
```

### dseams.selectEdgeAtomsInRingsWithinSlice {#dseams-selectedgeatomsinringswithinslice}

```lua
selectEdgeAtomsInRingsWithinSlice
```

### dseams.selectInSingleSlice {#dseams-selectinsingleslice}

```lua
selectInSingleSlice
```

### dseams.shellRingCensus {#dseams-shellringcensus}

```lua
shellRingCensus
```

### dseams.shellSeparation {#dseams-shellseparation}

```lua
shellSeparation
```

### dseams.soapSpectrum {#dseams-soapspectrum}

```lua
soapSpectrum
```

### dseams.soapSpectrumAll {#dseams-soapspectrumall}

```lua
soapSpectrumAll
```

### dseams.steinhardtQl {#dseams-steinhardtql}

```lua
steinhardtQl
```

### dseams.steinhardtQlVoronoi {#dseams-steinhardtqlvoronoi}

```lua
steinhardtQlVoronoi
```

### dseams.topologyFingerprint {#dseams-topologyfingerprint}

```lua
topologyFingerprint
```

### dseams.topologyLibrary {#dseams-topologylibrary}

```lua
topologyLibrary
```

### dseams.voronoiFacetWeights {#dseams-voronoifacetweights}

```lua
voronoiFacetWeights
```

### dseams.voronoiFeatures {#dseams-voronoifeatures}

```lua
voronoiFeatures
```

### dseams.writeDump {#dseams-writedump}

```lua
writeDump
```

### dseams.writeHistogram {#dseams-writehistogram}

```lua
writeHistogram
```

## C API {#c-api}

Each native call and the `seams.h` or `seams_lang.h` function it uses. The C column is the stable ABI.

| Native | C |
| --- | --- |
| dseams.averageQ6 | no direct C call |
| dseams.bondClassifierNames | no direct C call |
| dseams.bondNetworkByIndex | no direct C call |
| dseams.bulkRingNumberAnalysis | no direct C call |
| dseams.bulkTopoUnitMatching | no direct C call |
| dseams.bulkTopologicalNetworkCriterion | no direct C call |
| dseams.cageAffiliation | no direct C call |
| dseams.calcCN | no direct C call |
| dseams.calcRDF | no direct C call |
| dseams.calcRDF3D | no direct C call |
| dseams.calcRunningCN | no direct C call |
| dseams.chillPlus_cij | no direct C call |
| dseams.chillPlus_iceType | no direct C call |
| dseams.chill_cij | no direct C call |
| dseams.chill_iceType | no direct C call |
| dseams.classifyBonds | no direct C call |
| dseams.classifyTemplates | no direct C call |
| dseams.classifyTopology | no direct C call |
| dseams.clusterAnalysis | no direct C call |
| dseams.contactPairs | no direct C call |
| dseams.densityByKind | no direct C call |
| dseams.densityByType | no direct C call |
| dseams.domainStats | no direct C call |
| dseams.donatedHydrogenBond | no direct C call |
| dseams.findBySignature | no direct C call |
| dseams.getCorrel | no direct C call |
| dseams.getCorrelPlus | no direct C call |
| dseams.getHbondNetwork | no direct C call |
| dseams.getHbondNetworkFromClouds | no direct C call |
| dseams.getHbondNetworkFromDonors | no direct C call |
| dseams.getIceType | no direct C call |
| dseams.getIceTypeNoPrint | no direct C call |
| dseams.getIceTypePlus | no direct C call |
| dseams.getIceTypePlusNoPrint | no direct C call |
| dseams.getNewNeighbourListByIndex | no direct C call |
| dseams.getPointCloudAtomsOfOneAtomType | no direct C call |
| dseams.getPrimitiveRings | no direct C call |
| dseams.guestOccupancy | no direct C call |
| dseams.indicesOf | no direct C call |
| dseams.ionCloud | no direct C call |
| dseams.ionEnvironment | no direct C call |
| dseams.kNearestNeighbourList | no direct C call |
| dseams.kNearestNeighbourPair | no direct C call |
| dseams.localTopologyKey | no direct C call |
| dseams.modifyChill | no direct C call |
| dseams.mutualNearestUnlike | no direct C call |
| dseams.neighListO | no direct C call |
| dseams.neighListPair | no direct C call |
| dseams.neighborList | no direct C call |
| dseams.neighbourListByIndex | no direct C call |
| dseams.parseSiteSpec | no direct C call |
| dseams.percentage_Ice | no direct C call |
| dseams.periodicCentroid | no direct C call |
| dseams.prismAnalysis | no direct C call |
| dseams.readChemfiles | no direct C call |
| dseams.readCon | no direct C call |
| dseams.readFrame | no direct C call |
| dseams.readFrameOnlyOne | no direct C call |
| dseams.readFrameOnlyOneAllAtoms | no direct C call |
| dseams.readLammpsTrj | no direct C call |
| dseams.readLammpsTrjO | no direct C call |
| dseams.readLammpsTrjreduced | no direct C call |
| dseams.readXYZ | no direct C call |
| dseams.recenterCluster | no direct C call |
| dseams.registerBondClassifier | no direct C call |
| dseams.ringAnalysis | no direct C call |
| dseams.ringNetwork | no direct C call |
| dseams.seededCageAffiliation | no direct C call |
| dseams.selectAtomsInSliceWithRingEdgeAtoms | no direct C call |
| dseams.selectEdgeAtomsInRingsWithinSlice | no direct C call |
| dseams.selectInSingleSlice | no direct C call |
| dseams.shellRingCensus | no direct C call |
| dseams.shellSeparation | no direct C call |
| dseams.soapSpectrum | no direct C call |
| dseams.soapSpectrumAll | no direct C call |
| dseams.steinhardtQl | no direct C call |
| dseams.steinhardtQlVoronoi | no direct C call |
| dseams.topologyFingerprint | no direct C call |
| dseams.topologyLibrary | no direct C call |
| dseams.voronoiFacetWeights | no direct C call |
| dseams.voronoiFeatures | no direct C call |
| dseams.writeDump | no direct C call |
| dseams.writeHistogram | no direct C call |
