org.openscience.cdk.fingerprint

Class SignatureFingerprinter

java.lang.Object

org.openscience.cdk.fingerprint.AbstractFingerprinter

org.openscience.cdk.fingerprint.SignatureFingerprinter

All Implemented Interfaces:

IFingerprinter

public class SignatureFingerprinter
extends AbstractFingerprinter
implements IFingerprinter

An implementation of a AtomSignature-based fingerprint.

Source code:

master

Belongs to CDK module:

signature

Keywords:

fingerprint

Constructor Summary

Constructors

Constructor and Description
SignatureFingerprinter() Initialize the fingerprinter with a default signature depth of 1.
SignatureFingerprinter(int depth) Initialize the fingerprinter with a certain signature depth.

Method Summary

Modifier and Type	Method and Description
IBitFingerprint	getBitFingerprint(IAtomContainer atomContainer) Returns the bit fingerprint for the given IAtomContainer.
ICountFingerprint	getCountFingerprint(IAtomContainer container) Returns the count fingerprint for the given IAtomContainer.
protected List<Map.Entry<String,String>>	getParameters() Base classes should override this method to report the parameters they are configured with.
Map<String,Integer>	getRawFingerprint(IAtomContainer atomContainer) Returns the raw representation of the fingerprint for the given IAtomContainer.
int	getSize() Returns the size (or length) of the fingerprint.

Methods inherited from class org.openscience.cdk.fingerprint.AbstractFingerprinter

getFingerprint, getVersionDescription

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openscience.cdk.fingerprint.IFingerprinter

getFingerprint, getVersionDescription

Constructor Detail

SignatureFingerprinter

public SignatureFingerprinter()

Initialize the fingerprinter with a default signature depth of 1.

SignatureFingerprinter

public SignatureFingerprinter(int depth)

Initialize the fingerprinter with a certain signature depth.

Parameters:

depth - The depth of the signatures to calculate.

Method Detail

getParameters

protected List<Map.Entry<String,String>> getParameters()

Description copied from class: AbstractFingerprinter

Base classes should override this method to report the parameters they are configured with.

Overrides:

getParameters in class AbstractFingerprinter

Returns:

The key=value pairs of configured parameters

getBitFingerprint

public IBitFingerprint getBitFingerprint(IAtomContainer atomContainer)
                                  throws CDKException

Description copied from interface: IFingerprinter

Returns the bit fingerprint for the given IAtomContainer.

Specified by:

getBitFingerprint in interface IFingerprinter

Parameters:

atomContainer - IAtomContainer for which the fingerprint should be calculated.

Returns:

the bit fingerprint

Throws:

CDKException - may be thrown if there is an error during aromaticity detection or (for key based fingerprints) if there is a SMARTS parsing error

getRawFingerprint

public Map<String,Integer> getRawFingerprint(IAtomContainer atomContainer)
                                      throws CDKException

Description copied from interface: IFingerprinter

Returns the raw representation of the fingerprint for the given IAtomContainer. The raw representation contains counts as well as the key strings.

Specified by:

getRawFingerprint in interface IFingerprinter

Parameters:

atomContainer - IAtomContainer for which the fingerprint should be calculated.

Returns:

the raw fingerprint

Throws:

CDKException

getSize

public int getSize()

Description copied from interface: IFingerprinter

Returns the size (or length) of the fingerprint.

Specified by:

getSize in interface IFingerprinter

Returns:

the size of the fingerprint

getCountFingerprint

public ICountFingerprint getCountFingerprint(IAtomContainer container)
                                      throws CDKException

Description copied from interface: IFingerprinter

Returns the count fingerprint for the given IAtomContainer.

Specified by:

getCountFingerprint in interface IFingerprinter

Parameters:

container - IAtomContainer for which the fingerprint should be calculated.

Returns:

the count fingerprint

Throws:

CDKException - if there is an error during aromaticity detection or (for key based fingerprints) if there is a SMARTS parsing error.