Package ghidra.program.util

# Interface AddressCorrelator

All Known Subinterfaces:
  `DiscoverableAddressCorrelator`

public interface AddressCorrelator
Interface for address correlation algorithms that can generate an address mapping from one set of program addresses to another.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `AddressCorrelation`
  `correlate(Data sourceData, Data destinationData)`
  Returns an address mapping from one piece of data to another.
  `AddressCorrelation`
  `correlate(Function sourceFunction, Function destinationFunction)`
  Returns an address mapping from one function to another.
  `Options`
  `getDefaultOptions()`
  Returns the options with the default settings for this correlator.
  `ToolOptions`
  `getOptions()`
  Returns the current Option settings for this correlator.
  `void`
  `setOptions(ToolOptions options)`
  Sets the options to use for this correlator.

- ## Method Details

  - ### correlate

    AddressCorrelation correlate(Function sourceFunction, Function destinationFunction)
    Returns an address mapping from one function to another.
    Parameters:
      `sourceFunction` - the source function.
      `destinationFunction` - the destination function.
    Returns:
      an AddressCorrelation that represents a mapping of the addresses from the source function to the destination function.

  - ### correlate

    AddressCorrelation correlate(Data sourceData, Data destinationData)
    Returns an address mapping from one piece of data to another.
    Parameters:
      `sourceData` - the source data.
      `destinationData` - the destination data.
    Returns:
      an AddressCorrelation that represents a mapping of the addresses from the source data to the destination data.

  - ### getOptions

    ToolOptions getOptions()
    Returns the current Option settings for this correlator.
    Returns:
      the current Option settings for this correlator.

  - ### setOptions

    void setOptions(ToolOptions options)
    Sets the options to use for this correlator.
    Parameters:
      `options` - the options to use for this correlator.

  - ### getDefaultOptions

    Options getDefaultOptions()
    Returns the options with the default settings for this correlator.
    Returns:
      the options with the default settings for this correlator.