MeterStructureFactor

java.lang.Object
- etomica.data.meter.MeterStructureFactor

All Implemented Interfaces:

DataSourceIndependent, IDataSource
```
public class MeterStructureFactor
extends java.lang.Object
implements IDataSource, DataSourceIndependent
```
Meter for calculation of structure factor of atoms for all wave vectors less than a cutoff.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface MeterStructureFactor.AtomSignalSource

static class MeterStructureFactor.AtomSignalSourceByType

Nested Classes
Modifier and Type	Class	Description
`static interface`	`MeterStructureFactor.AtomSignalSource`
`static class`	`MeterStructureFactor.AtomSignalSourceByType`

Field Summary

Fields
Modifier and Type	Field	Description
`protected IAtomList`	`atomList`
`protected Box`	`box`
`protected double`	`cutoff`
`protected DataFunction`	`data`
`protected DataFunction.DataInfoFunction`	`dataInfo`
`protected boolean`	`normalizeByN`
`protected double[]`	`phaseAngles`
`protected MeterStructureFactor.AtomSignalSource`	`signalSource`
`protected Space`	`space`
`protected double[]`	`struct`
`protected DataTag`	`tag`
`protected Vector[]`	`waveVec`
`protected DataDoubleArray`	`xData`
`protected DataDoubleArray.DataInfoDoubleArray`	`xDataInfo`
`protected DataTag`	`xTag`

Constructor Summary

Constructors
Constructor	Description
`MeterStructureFactor(Box aBox, double cutoff)`	Creates meter with default to compute the structure factor for all atoms in the box.
`MeterStructureFactor(Box aBox, double cutoff, MeterStructureFactor.AtomSignalSource signalSource)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`getCutoff()`
`IData`	`getData()`
`IDataInfo`	`getDataInfo()`
`int`	`getIndependentArrayDimension()`	Returns the number of independent data dimensions
`DataDoubleArray`	`getIndependentData(int i)`	Returns the X data for the given dimension
`DataDoubleArray.DataInfoDoubleArray`	`getIndependentDataInfo(int i)`	Returns the DataInfo for the given dimension
`DataTag`	`getIndependentTag()`	Returns the tag associated with this DataSource.
`double[]`	`getPhaseAngles()`
`MeterStructureFactor.AtomSignalSource`	`getSignalSource()`
`DataTag`	`getTag()`
`Vector[]`	`getWaveVectors()`
`protected int`	`makeWaveVector(double cutoff)`
`protected void`	`resetData()`
`void`	`setAtoms(IAtomList atomList)`
`void`	`setCutoff(double cutoff)`	Sets the wave vector cutoff.
`void`	`setNormalizeByN(boolean normalizeByN)`	Normalizing by N will produce a structure factor that is insensitive to finite-size effects if there is no long-range order.
`void`	`setWaveVec(Vector[] waveVec)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - space
```
protected final Space space
```
  - box
```
protected Box box
```
  - struct
```
protected double[] struct
```
  - waveVec
```
protected Vector[] waveVec
```
  - atomList
```
protected IAtomList atomList
```
  - data
```
protected DataFunction data
```
  - dataInfo
```
protected DataFunction.DataInfoFunction dataInfo
```
  - tag
```
protected final DataTag tag
```
  - xTag
```
protected final DataTag xTag
```
  - xData
```
protected DataDoubleArray xData
```
  - xDataInfo
```
protected DataDoubleArray.DataInfoDoubleArray xDataInfo
```
  - signalSource
```
protected final MeterStructureFactor.AtomSignalSource signalSource
```
  - cutoff
```
protected double cutoff
```
  - phaseAngles
```
protected double[] phaseAngles
```
  - normalizeByN
```
protected boolean normalizeByN
```
- Constructor Detail
  - MeterStructureFactor
```
public MeterStructureFactor(Box aBox,
                            double cutoff)
```
    Creates meter with default to compute the structure factor for all atoms in the box. All wave vectors consistent with the box shape and with magnitude less than cutoff are included.
  - MeterStructureFactor
```
public MeterStructureFactor(Box aBox,
                            double cutoff,
                            MeterStructureFactor.AtomSignalSource signalSource)
```
- Method Detail
  - setNormalizeByN
```
public void setNormalizeByN(boolean normalizeByN)
```
    Normalizing by N will produce a structure factor that is insensitive to finite-size effects if there is no long-range order. With long-range order, normalizing by N^2 (the default) will produce a structure factor that is insensitive to finite-size effects.
  - getSignalSource
```
public MeterStructureFactor.AtomSignalSource getSignalSource()
```
  - resetData
```
protected void resetData()
```
  - makeWaveVector
```
protected int makeWaveVector(double cutoff)
```
  - setCutoff
```
public void setCutoff(double cutoff)
```
    Sets the wave vector cutoff. All wave vectors consistent with the box shape that have a magnitude less than the cutoff will be computed.
    
    Parameters:
    
    cutoff - the cutoff for the wave vector magnitude
  - getCutoff
```
public double getCutoff()
```
  - setWaveVec
```
public void setWaveVec(Vector[] waveVec)
```
    Parameters:
    
    waveVec - Sets a custom wave vector array.
  - setAtoms
```
public void setAtoms(IAtomList atomList)
```
    Parameters:
    
    atomList - Sets the list of atoms for factor calculation.
  - getData
```
public IData getData()
```
    Specified by:
    
    getData in interface IDataSource
    
    Returns:
    
    the data given by this source
  - getWaveVectors
```
public Vector[] getWaveVectors()
```
  - getPhaseAngles
```
public double[] getPhaseAngles()
```
  - getTag
```
public DataTag getTag()
```
    Specified by:
    
    getTag in interface IDataSource
    
    Returns:
    
    a tag that uniquely identifies the IDataInfo
  - getDataInfo
```
public IDataInfo getDataInfo()
```
    Specified by:
    
    getDataInfo in interface IDataSource
  - getIndependentData
```
public DataDoubleArray getIndependentData(int i)
```
    Description copied from interface: DataSourceIndependent
    
    Returns the X data for the given dimension
    
    Specified by:
    
    getIndependentData in interface DataSourceIndependent
  - getIndependentDataInfo
```
public DataDoubleArray.DataInfoDoubleArray getIndependentDataInfo(int i)
```
    Description copied from interface: DataSourceIndependent
    
    Returns the DataInfo for the given dimension
    
    Specified by:
    
    getIndependentDataInfo in interface DataSourceIndependent
  - getIndependentArrayDimension
```
public int getIndependentArrayDimension()
```
    Description copied from interface: DataSourceIndependent
    
    Returns the number of independent data dimensions
    
    Specified by:
    
    getIndependentArrayDimension in interface DataSourceIndependent
  - getIndependentTag
```
public DataTag getIndependentTag()
```
    Description copied from interface: DataSourceIndependent
    
    Returns the tag associated with this DataSource.
    
    Specified by:
    
    getIndependentTag in interface DataSourceIndependent

Class MeterStructureFactor

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

space

box

struct

waveVec

atomList

data

dataInfo

tag

xTag

xData

xDataInfo

signalSource

cutoff

phaseAngles

normalizeByN

Constructor Detail

MeterStructureFactor

MeterStructureFactor

Method Detail

setNormalizeByN

getSignalSource

resetData

makeWaveVector

setCutoff

getCutoff

setWaveVec

setAtoms

getData

getWaveVectors

getPhaseAngles

getTag

getDataInfo

getIndependentData

getIndependentDataInfo

getIndependentArrayDimension

getIndependentTag