CgCrossoverColorMaker | catana-backend

Higlights nucleotides which are taking part in a DNA origami crossover. The computation of which nucleotides are in a crossover is approximate and may yield incorrect results. However, it should provide a basic idea of the crossover ratio.

Hierarchy

Colormaker
- CgCrossoverColorMaker

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CgCrossoverColorMaker(params?: Partial<ColormakerParameters>): CgCrossoverColorMaker

Inherited from EntitytypeColormaker.constructor
- Defined in backend/src/color/colormaker.ts:52
Create a colormaker instance

Parameters
- Default value params: Partial<ColormakerParameters> = {}
  
  colormaker parameter
Returns CgCrossoverColorMaker

Properties

Optional atomProxy

atomProxy: AtomProxy

parameters

parameters: ColormakerParameters

Accessors

Private crossoverColor

get crossoverColor(): number

- Defined in backend/src/catana/color/cg-crossover-color-maker.ts:33
Returns number

Private defaultColor

get defaultColor(): number

- Defined in backend/src/catana/color/cg-crossover-color-maker.ts:37
Returns number

Methods

Optional atomColor

atomColor(atom: AtomProxy): number

Inherited from ElectrostaticColormaker.atomColor
- Defined in backend/src/color/colormaker.ts:112
Parameters
- atom: AtomProxy
Returns number

atomColorToArray

atomColorToArray(atom: AtomProxy, array: NumberArray, offset: number): NumberArray

Inherited from AtomindexColormaker.atomColorToArray
- Defined in backend/src/color/colormaker.ts:121
safe a atom color to an array

Parameters
- atom: AtomProxy
  
  atom to get color for
- array: NumberArray
  
  destination
- offset: number
  
  index into the array
Returns NumberArray

the destination array

bondColor

bondColor(bond: BondProxy, fromTo: boolean): number

Inherited from AtomindexColormaker.bondColor
- Defined in backend/src/color/colormaker.ts:133
return the color for an bond

Parameters
- bond: BondProxy
  
  bond to get color for
- fromTo: boolean
  
  whether to use the first or second atom of the bond
Returns number

hex bond color

bondColorToArray

bondColorToArray(bond: BondProxy, fromTo: boolean, array: NumberArray, offset: number): NumberArray

Inherited from AtomindexColormaker.bondColorToArray
- Defined in backend/src/color/colormaker.ts:150
safe a bond color to an array

Parameters
- bond: BondProxy
  
  bond to get color for
- fromTo: boolean
  
  whether to use the first or second atom of the bond
- array: NumberArray
  
  destination
- offset: number
  
  index into the array
Returns NumberArray

the destination array

colorToArray

colorToArray(color: number, array?: NumberArray, offset?: number): NumberArray

Inherited from AtomindexColormaker.colorToArray
- Defined in backend/src/color/colormaker.ts:104
safe a color to an array

Parameters
- color: number
  
  hex color value
- Default value array: NumberArray = []
  
  destination
- Default value offset: number = 0
  
  index into the array
Returns NumberArray

the destination array

generateColors

generateColors(howMany: number, params?: Partial<ScaleParameters>): string[]

Inherited from AtomindexColormaker.generateColors
- Defined in backend/src/color/colormaker.ts:76
Parameters
- howMany: number
- Default value params: Partial<ScaleParameters> = {}
Returns string[]

getScale

getScale(params?: Partial<ScaleParameters>): Scale<any>

Inherited from AtomindexColormaker.getScale
- Defined in backend/src/color/colormaker.ts:70
Parameters
- Default value params: Partial<ScaleParameters> = {}
Returns Scale<any>

Private isInCrossover

isInCrossover(m: CgMonomerProxy | null): boolean

- Defined in backend/src/catana/color/cg-crossover-color-maker.ts:41
Parameters
- m: CgMonomerProxy | null
Returns boolean

monomerBondColor

monomerBondColor(b: CgMonomerBondProxy): number

Overrides AtomindexColormaker.monomerBondColor
- Defined in backend/src/catana/color/cg-crossover-color-maker.ts:21
Parameters
- b: CgMonomerBondProxy
Returns number

monomerBondColorToArray

monomerBondColorToArray(m: CgMonomerBondProxy, array: NumberArray, offset: number): NumberArray

Inherited from AtomindexColormaker.monomerBondColorToArray
- Defined in backend/src/color/colormaker.ts:196
Parameters
- m: CgMonomerBondProxy
- array: NumberArray
- offset: number
Returns NumberArray

monomerColor

monomerColor(m: CgMonomerProxy): number

Overrides AtomindexColormaker.monomerColor
- Defined in backend/src/catana/color/cg-crossover-color-maker.ts:14
Parameters
- m: CgMonomerProxy
Returns number

monomerColorToArray

monomerColorToArray(m: CgMonomerProxy, array: NumberArray, offset: number): NumberArray

Inherited from AtomindexColormaker.monomerColorToArray
- Defined in backend/src/color/colormaker.ts:190
Parameters
- m: CgMonomerProxy
- array: NumberArray
- offset: number
Returns NumberArray

Optional positionColor

positionColor(position: Vector3): number

Inherited from AtomindexColormaker.positionColor
- Defined in backend/src/color/colormaker.ts:171
Parameters
- position: Vector3
Returns number

positionColorToArray

positionColorToArray(coords: Vector3, array: NumberArray, offset: number): NumberArray

Inherited from AtomindexColormaker.positionColorToArray
- Defined in backend/src/color/colormaker.ts:180
safe a color for coordinates in space to an array

Parameters
- coords: Vector3
  
  xyz coordinates
- array: NumberArray
  
  destination
- offset: number
  
  index into the array
Returns NumberArray

the destination array

Optional volumeColor

volumeColor(index: number): number

Inherited from AtomindexColormaker.volumeColor
- Defined in backend/src/color/colormaker.ts:156
Parameters
- index: number
Returns number

volumeColorToArray

volumeColorToArray(index: number, array: NumberArray, offset: number): NumberArray

Inherited from AtomindexColormaker.volumeColorToArray
- Defined in backend/src/color/colormaker.ts:165
safe a volume cell color to an array

Parameters
- index: number
  
  volume cell index
- array: NumberArray
  
  destination
- offset: number
  
  index into the array
Returns NumberArray

the destination array

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Default value params: Partial<ColormakerParameters> = {}

Returns CgCrossoverColorMaker

Properties

Optional atomProxy

parameters

Accessors

Private crossoverColor

Returns number

Private defaultColor

Returns number

Methods

Optional atomColor

Parameters

atom: AtomProxy

Returns number

atomColorToArray

Parameters

atom: AtomProxy

array: NumberArray

offset: number

Returns NumberArray

bondColor

Parameters

bond: BondProxy

fromTo: boolean

Returns number

bondColorToArray

Parameters

bond: BondProxy

fromTo: boolean

array: NumberArray

offset: number

Returns NumberArray

colorToArray

Parameters

color: number

Default value array: NumberArray = []

Default value offset: number = 0

Returns NumberArray

generateColors

Parameters

howMany: number

Default value params: Partial<ScaleParameters> = {}

Returns string[]

getScale

Parameters

Default value params: Partial<ScaleParameters> = {}

Returns Scale<any>

Private isInCrossover

Parameters

m: CgMonomerProxy | null

Returns boolean

monomerBondColor

Parameters

b: CgMonomerBondProxy

Returns number

monomerBondColorToArray

Parameters

m: CgMonomerBondProxy

array: NumberArray

offset: number

Returns NumberArray

monomerColor

Parameters

m: CgMonomerProxy

Returns number

monomerColorToArray

Parameters

m: CgMonomerProxy

array: NumberArray

offset: number