org.openscience.cdk.qsar.descriptors.molecular
Class PetitjeanShapeIndexDescriptor

java.lang.Object
  org.openscience.cdk.qsar.descriptors.molecular.PetitjeanShapeIndexDescriptor

All Implemented Interfaces:

IDescriptor, IMolecularDescriptor

public class PetitjeanShapeIndexDescriptor
extends java.lang.Object
implements IMolecularDescriptor

Evaluates the Petitjean shape indices,

These original Petitjean number was described by Petitjean ([ Petitjean, M. , Applications of the radius-diameter diagram to the classification of topological and geometrical shapes of chemical compounds, Journal of Chemical Information and Computer Science, 1992, 32:331-337]) and considered the molecular graph. This class also implements the geometric analog of the topological shape index described by Bath et al ([ Bath, P.A. and Poirette, A.R. and Willet, P. and Allen, F.H. , The Extent of the Relationship between the Graph-Theoretical and the Geometrical Shape Coefficients of Chemical Compounds, Journal of Chemical Information and Computer Science, 1995, 35:714-716]).

The descriptor returns a DoubleArrayResult which contains

1. topoShape - topological shape index
2. geomShape - geometric shape index

This descriptor uses these parameters:

Name	Default	Description
		no parameters

Author:

Rajarshi Guha

Belongs to the set:

qsar-descriptors

Keywords:

Petit-Jean, shape index

Created on:

2006-01-14

Belongs to CDK module:

qsarmolecular

Dictionary pointer(s):

petitjeanShapeIndex in the QSAR.sf.net Descriptors Dictionary [qsar-descriptors:petitjeanShapeIndex]

Source code:

revision 11707

Constructor Summary

PetitjeanShapeIndexDescriptor()

Method Summary

DescriptorValue	calculate(IAtomContainer container) Calculates the two Petitjean shape indices.
java.lang.String[]	getDescriptorNames() Returns an array of names for each descriptor value calculated.
IDescriptorResult	getDescriptorResultType() Returns the specific type of the DescriptorResult object.
java.lang.String[]	getParameterNames() Gets the parameterNames attribute of the PetitjeanShapeIndexDescriptor object.
java.lang.Object[]	getParameters() Gets the parameters attribute of the PetitjeanShapeIndexDescriptor object.
java.lang.Object	getParameterType(java.lang.String name) Gets the parameterType attribute of the PetitjeanShapeIndexDescriptor object.
DescriptorSpecification	getSpecification() Returns a Map which specifies which descriptor is implemented by this class.
void	setParameters(java.lang.Object[] params) Sets the parameters attribute of the PetitjeanShapeIndexDescriptor object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PetitjeanShapeIndexDescriptor

public PetitjeanShapeIndexDescriptor()

Method Detail

getSpecification

public DescriptorSpecification getSpecification()

Description copied from interface: IDescriptor

Returns a Map which specifies which descriptor is implemented by this class. These fields are used in the map:

• Specification-Reference: refers to an entry in a unique dictionary
• Implementation-Title: anything
• Implementation-Identifier: a unique identifier for this version of this class
• Implementation-Vendor: CDK, JOELib, or anything else

Specified by:

getSpecification in interface IDescriptor

Returns:

An object containing the descriptor specification

setParameters

public void setParameters(java.lang.Object[] params)
                   throws CDKException

Sets the parameters attribute of the PetitjeanShapeIndexDescriptor object.

Specified by:

setParameters in interface IDescriptor

Parameters:

params - The new parameters value

Throws:

CDKException - Description of the Exception

See Also:

IDescriptor.getParameters()

getParameters

public java.lang.Object[] getParameters()

Gets the parameters attribute of the PetitjeanShapeIndexDescriptor object.

Specified by:

getParameters in interface IDescriptor

Returns:

The parameters value

See Also:

IDescriptor.setParameters(java.lang.Object[])

getDescriptorNames

@TestMethod(value="testNamesConsistency")
public java.lang.String[] getDescriptorNames()

Description copied from interface: IDescriptor

Returns an array of names for each descriptor value calculated.

Many descriptors return multiple values. In general it is useful for the descriptor to indicate the names for each value.

In many cases, these names can be as simple as X1, X2, ..., XN where X is a prefix and 1, 2, ..., N are the indices. On the other hand it is also possible to return other arbitrary names, which should be documented in the Javadocs for the decsriptor (e.g., the CPSA descriptor).

Note that by default if a descriptor returns a single value (such as ALOGPDescriptor the return array will have a single element

Specified by:

getDescriptorNames in interface IDescriptor

Returns:

An array of descriptor names, equal in length to the number of descriptor calculated..

getParameterNames

public java.lang.String[] getParameterNames()

Gets the parameterNames attribute of the PetitjeanShapeIndexDescriptor object.

Specified by:

getParameterNames in interface IDescriptor

Returns:

The parameterNames value

getParameterType

public java.lang.Object getParameterType(java.lang.String name)

Gets the parameterType attribute of the PetitjeanShapeIndexDescriptor object.

Specified by:

getParameterType in interface IDescriptor

Parameters:

name - Description of the Parameter

Returns:

The parameterType value

calculate

public DescriptorValue calculate(IAtomContainer container)

Calculates the two Petitjean shape indices.

Specified by:

calculate in interface IMolecularDescriptor

Parameters:

container - Parameter is the atom container.

Returns:

A DoubleArrayResult value representing the Petitjean shape indices

getDescriptorResultType

public IDescriptorResult getDescriptorResultType()

Returns the specific type of the DescriptorResult object.

The return value from this method really indicates what type of result will be obtained from the DescriptorValue object. Note that the same result can be achieved by interrogating the DescriptorValue object; this method allows you to do the same thing, without actually calculating the descriptor.

Specified by:

getDescriptorResultType in interface IMolecularDescriptor

Returns:

an object that implements the IDescriptorResult interface indicating the actual type of values returned by the descriptor in the DescriptorValue object