ImageFunction

under construction:Undocumented Class

The ImageFunction has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.


# ImageFunction

!syntax description /Functions/ImageFunction

## Overview

!! Replace these lines with information regarding the ImageFunction object.

## Example Input File Syntax

!! Describe and include an example of how to use the ImageFunction object.

!syntax parameters /Functions/ImageFunction

!syntax inputs /Functions/ImageFunction

!syntax children /Functions/ImageFunction

Function with values sampled from a given image stack

Input Parameters

componentThe image RGB-component to return, leaving this blank will result in a greyscale value for the image to be created. The component number is zero based, i.e. 0 returns the first (RED) component of the image.
C++ Type:unsigned int
Options:
Description:The image RGB-component to return, leaving this blank will result in a greyscale value for the image to be created. The component number is zero based, i.e. 0 returns the first (RED) component of the image.
dimensionsx,y,z dimensions of the image (defaults to mesh dimensions)
C++ Type:libMesh::Point
Options:
Description:x,y,z dimensions of the image (defaults to mesh dimensions)
fileName of single image file to extract mesh parameters from. If provided, a 2D mesh is created.
C++ Type:FileName
Options:
Description:Name of single image file to extract mesh parameters from. If provided, a 2D mesh is created.
file_baseImage file base to open, use this option when a stack of images must be read (ignored if 'file' is given)
C++ Type:FileNameNoExtension
Options:
Description:Image file base to open, use this option when a stack of images must be read (ignored if 'file' is given)
file_rangeRange of images to analyze, used with 'file_base' (ignored if 'file' is given)
C++ Type:std::vector
Options:
Description:Range of images to analyze, used with 'file_base' (ignored if 'file' is given)
file_suffixSuffix of the file to open, e.g. 'png'
C++ Type:std::string
Options:
Description:Suffix of the file to open, e.g. 'png'
originOrigin of the image (defaults to mesh origin)
C++ Type:libMesh::Point
Options:
Description:Origin of the image (defaults to mesh origin)

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.

Advanced Parameters

flip_xFalseFlip the image along the x-axis
Default:False
C++ Type:bool
Options:
Description:Flip the image along the x-axis
flip_yFalseFlip the image along the y-axis
Default:False
C++ Type:bool
Options:
Description:Flip the image along the y-axis
flip_zFalseFlip the image along the z-axis
Default:False
C++ Type:bool
Options:
Description:Flip the image along the z-axis

Flip Parameters

lower_value0The value to set for data less than the threshold value
Default:0
C++ Type:double
Options:
Description:The value to set for data less than the threshold value
thresholdThe threshold value
C++ Type:double
Options:
Description:The threshold value
upper_value1The value to set for data greater than the threshold value
Default:1
C++ Type:double
Options:
Description:The value to set for data greater than the threshold value

Threshold Parameters

scale1Multiplier to apply to all pixel values; occurs after shifting
Default:1
C++ Type:double
Options:
Description:Multiplier to apply to all pixel values; occurs after shifting
shift0Value to add to all pixels; occurs prior to scaling
Default:0
C++ Type:double
Options:
Description:Value to add to all pixels; occurs prior to scaling

Rescale Parameters

Input Files

test/tests/functions/image_function/subset.i
test/tests/functions/image_function/threshold_adapt.i
test/tests/functions/image_function/moose_logo_test_2D.i
test/tests/functions/image_function/flip_quad.i
test/tests/functions/image_function/error/check_error.i
modules/phase_field/test/tests/feature_flood_test/parallel_feature_count.i
test/tests/functions/image_function/flip_dual.i
test/tests/functions/image_function/shift_and_scale.i
test/tests/functions/image_function/error/threshold_values.i
test/tests/functions/image_function/component.i
test/tests/functions/image_function/image_2d.i
test/tests/functions/image_function/image_2d_elemental.i
test/tests/functions/image_function/flip.i
test/tests/functions/image_function/image_3d_subset.i
test/tests/functions/image_function/threshold.i
test/tests/functions/image_function/image.i
test/tests/functions/image_function/image_mesh_2d.i
test/tests/functions/image_function/crop.i
test/tests/functions/image_function/threshold_adapt_parallel.i
test/tests/functions/image_function/image_mesh_3d.i
test/tests/functions/image_function/image_3d.i
modules/phase_field/test/tests/boundary_intersecting_features/boundary_intersecting_features.i

test/tests/functions/image_function/subset.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 10
  ny = 10
  uniform_refine = 2
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./image_func]
    type = ImageFunction
    file_base = stack/test
    file_suffix = png
    file_range = '0' # file_range is a vector input, a single entry means "read only 1 file"
    origin = '0.25 0.25 0'
    dimensions = '0.5 0.5 0'
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = image_func
    variable = u
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
[]

[Outputs]
  exodus = true
[]

test/tests/functions/image_function/threshold_adapt.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 2
  ny = 2
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./image_func]
    type = ImageFunction
    file_base = stack/test
    file_suffix = png
    file_range = '0' # file_range is a vector input, a single entry means "read only 1 file"
    threshold = 2.7e4
    upper_value = 1
    lower_value = -1
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = image_func
    variable = u
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
[]

[Adaptivity]
  max_h_level = 5
  initial_steps = 5
  initial_marker = marker
  [./Indicators]
    [./indicator]
      type = GradientJumpIndicator
      variable = u
    [../]
  [../]
  [./Markers]
    [./marker]
      type = ErrorFractionMarker
      indicator = indicator
      refine = 0.9
    [../]
  [../]
[]

[Outputs]
  exodus = true
[]

test/tests/functions/image_function/moose_logo_test_2D.i

[Problem]
  solve = false
[]

[Mesh]
  type = ImageMesh
  cells_per_pixel = 1
  dim = 2
  file = moose_logo_small.png
[]

[Variables]
  [./original]
    family = MONOMIAL
    order = CONSTANT
  [../]
  [./scaled]
    family = MONOMIAL
    order = CONSTANT
  [../]
  [./shifted]
    family = MONOMIAL
    order = CONSTANT
  [../]
[]

[Functions]
  [./image]
    type = ImageFunction
    file = moose_logo_small.png
  [../]
  [./image_scale]
    type = ImageFunction
    file = moose_logo_small.png
    scale = 0.00392156862
  [../]
  [./image_shift]
    type = ImageFunction
    file = moose_logo_small.png
    shift = -127.5
  [../]
[]

[ICs]
  [./original_IC]
    type = FunctionIC
    function = image
    variable = original
  [../]
  [./scaled_IC]
    type = FunctionIC
    function = image_scale
    variable = scaled
  [../]
  [./shifted_IC]
    type = FunctionIC
    function = image_shift
    variable = shifted
  [../]
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

test/tests/functions/image_function/flip_quad.i

[Mesh]
  uniform_refine = 1
  [gen]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 20
    ny = 20
    xmax = 2
    ymax = 2
  []
  # Define block IDs for the four quadrants in CCW order:
  # 1=top_right
  # 2=top_left
  # 3=bottom_left
  # 4=bottom_right
  [./top_right_modifier]
    input = gen
    type = SubdomainBoundingBoxGenerator
    top_right = '2 2 0'
    bottom_left = '1 1 0'
    block_id = 1
  [../]
  [./top_left_modifier]
    input = top_right_modifier
    type = SubdomainBoundingBoxGenerator
    top_right = '1 2 0'
    bottom_left = '0 1 0'
    block_id = 2
  [../]
  [./bottom_left_modifier]
    input = top_left_modifier
    type = SubdomainBoundingBoxGenerator
    top_right = '1 1 0'
    bottom_left = '0 0 0'
    block_id = 3
  [../]
  [./bottom_right_modifier]
    input = bottom_left_modifier
    type = SubdomainBoundingBoxGenerator
    top_right = '2 1 0'
    bottom_left = '1 0 0'
    block_id = 4
  [../]
[]

[Variables]
  [./u]
    family = MONOMIAL
    order = CONSTANT
  [../]
[]

[Functions]
  [./bottom_left_func]
    type = ImageFunction
    file_base = stack/test
    flip_x = true
    file_range = '0' # file_range is a vector input, a single entry means "read only 1 file"
    file_suffix = png
    origin = '0 0 0'
    dimensions = '1 1 0'
  [../]
  [./top_left_func]
    type = ImageFunction
    file_base = stack/test
    file_range = '0' # file_range is a vector input, a single entry means "read only 1 file"
    file_suffix = png
    origin = '0 1 0'
    dimensions = '1 1 0'
    flip_x = true
    flip_y = true
  [../]
  [./top_right_func]
    type = ImageFunction
    origin = '1 1 0'
    file_base = stack/test
    file_suffix = png
    flip_y = true
    file_range = '0' # file_range is a vector input, a single entry means "read only 1 file"
    dimensions = '1 1 0'
  [../]
  [./bottom_right_func]
    type = ImageFunction
    origin = '1 0 0'
    file_base = stack/test
    file_range = '0' # file_range is a vector input, a single entry means "read only 1 file"
    file_suffix = png
    dimensions = '1 1 0'
  [../]
[]

[ICs]
  # Defined the same way as the MeshGenerators
  [./top_right_ic]
    function = top_right_func
    variable = u
    type = FunctionIC
    block = 1
  [../]
  [./top_left_ic]
    function = top_left_func
    variable = u
    type = FunctionIC
    block = 2
  [../]
  [./bottom_left_ic]
    function = bottom_left_func
    variable = u
    type = FunctionIC
    block = 3
  [../]
  [./bottom_right_ic]
    function = bottom_right_func
    variable = u
    type = FunctionIC
    block = 4
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
[]

[Outputs]
  exodus = true
[]

test/tests/functions/image_function/error/check_error.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 20
  ny = 20
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./tif]
    type = ImageFunction
    file_base = stack/test
    file_suffix = png
    file_range = '0' # file_range is a vector input, a single entry means "read only 1 file"
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = tif
    variable = u
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[../]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
[]

[Outputs]
  exodus = true
[]

modules/phase_field/test/tests/feature_flood_test/parallel_feature_count.i

[Mesh]
  type = ImageMesh
  dim = 2
  file = spiral_16x16.png
  scale_to_one = false
[]

[Variables]
  [./u]
    order = CONSTANT
    family = MONOMIAL
  [../]
[]

[AuxVariables]
  [./feature]
    order = CONSTANT
    family = MONOMIAL
  [../]
  [./proc_id]
    order = CONSTANT
    family = MONOMIAL
  [../]
  [./feature_ghost]
    order = CONSTANT
    family = MONOMIAL
  [../]
[]

[AuxKernels]
  [./nodal_flood_aux]
    type = FeatureFloodCountAux
    variable = feature
    flood_counter = flood_count_pp
    execute_on = 'initial timestep_end'
  [../]
  [./proc_id]
    type = ProcessorIDAux
    variable = proc_id
    execute_on = 'initial timestep_end'
  [../]
  [./ghost]
    type = FeatureFloodCountAux
    variable = feature_ghost
    field_display = GHOSTED_ENTITIES
    flood_counter = flood_count_pp
    execute_on = 'initial timestep_end'
  [../]
[]

[Functions]
  [./tif]
    type = ImageFunction
    component = 0
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = tif
    variable = u
  [../]
[]

[Postprocessors]
  [./flood_count_pp]
    type = FeatureFloodCount
    variable = u
    threshold = 1.0
    execute_on = 'initial timestep_end'
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[]

[Executioner]
  type = Steady
[]

[Outputs]
  csv = true
[]

test/tests/functions/image_function/flip_dual.i

[Mesh]
  uniform_refine = 1
  [gen]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 20
    ny = 40
    ymax = 2
  []
  [./top]
    type = SubdomainBoundingBoxGenerator
    input = gen
    top_right = '1 2 0'
    bottom_left = '0 1 0'
    block_id = 1
  [../]
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./top]
    type = ImageFunction
    origin = '0 1 0'
    file_base = stack/test
    file_suffix = png
    flip_y = true
    file_range = '0' # file_range is a vector input, a single entry means "read only 1 file"
    dimensions = '1 1 0'
  [../]
  [./bottom]
    type = ImageFunction
    origin = '0 0 0'
    file_base = stack/test
    file_suffix = png
    file_range = '0' # file_range is a vector input, a single entry means "read only 1 file"
    dimensions = '1 1 0'
  [../]
[]

[ICs]
  [./top_ic]
    function = top
    variable = u
    type = FunctionIC
    block = 1
  [../]
  [./bottom_ic]
    function = bottom
    variable = u
    type = FunctionIC
    block = 0
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
[]

[Outputs]
  exodus = true
[]

test/tests/functions/image_function/shift_and_scale.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 20
  ny = 20
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./image_func]
    type = ImageFunction
    file_base = stack/test
    file_suffix = png
    file_range = '0' # file_range is a vector input, a single entry means "read only 1 file"
    shift = -62735.0
    scale = 0.0001
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = image_func
    variable = u
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
[]

[Outputs]
  exodus = true
[]

test/tests/functions/image_function/error/threshold_values.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 20
  ny = 20
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./tif]
    type = ImageFunction
    file_base = ../stack/test
    file_suffix = png
    file_range = '0' # file_range is a vector input, a single entry means "read only 1 file"
    threshold = 30000
    upper_value = 1
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = tif
    variable = u
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[../]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
[]

[Outputs]
  exodus = true
[]

test/tests/functions/image_function/component.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 20
  ny = 20
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./image_func]
    type = ImageFunction
    file_base = stack/test
    file_suffix = png
    file_range = '0' # file_range is a vector input, a single entry means "read only 1 file"
    component = 0
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = image_func
    variable = u
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[../]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
[]

[Outputs]
  exodus = true
[]

test/tests/functions/image_function/image_2d.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 20
  ny = 20
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./image_func]
    type = ImageFunction
    file_base = stack/test
    file_suffix = png
    file_range = '0' # file_range is a vector input, a single entry means "read only 1 file"
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = image_func
    variable = u
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[../]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
[]

[Outputs]
  exodus = true
[]

test/tests/functions/image_function/image_2d_elemental.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 20
  ny = 20
[]

[Variables]
  [./u]
    order = CONSTANT
    family = MONOMIAL
  [../]
[]

[Functions]
  [./image_func]
    type = ImageFunction
    file_base = stack/test
    file_suffix = png
    # file range is parsed as a vector of unsigned.  If it only has 1
    # entry, only a single file is read.
    file_range = '0'
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = image_func
    variable = u
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[../]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

test/tests/functions/image_function/flip.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 20
  ny = 20
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./image_func]
    type = ImageFunction
    file_base = stack/test
    file_suffix = png
    file_range = '0' # file_range is a vector input, a single entry means "read only 1 file"
    flip_x = true
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = image_func
    variable = u
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
[]

[Outputs]
  exodus = true
[]

test/tests/functions/image_function/image_3d_subset.i

[Mesh]
  type = GeneratedMesh
  dim = 3
  nx = 20
  ny = 20
  nz = 6
  zmax = 0.3
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./image_func]
    type = ImageFunction
    file_base = stack/test
    file_suffix = png
    file_range = '0 5'
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = image_func
    variable = u
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[../]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
[]

[Outputs]
  exodus = true
[]

test/tests/functions/image_function/threshold.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 20
  ny = 20
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./image_func]
    type = ImageFunction
    file_base = stack/test
    file_suffix = png
    file_range = '0' # file_range is a vector input, a single entry means "read only 1 file"
    threshold = 2.7e4
    upper_value = 1
    lower_value = -1
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = image_func
    variable = u
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[../]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
[]

[Outputs]
  exodus = true
[]

test/tests/functions/image_function/image.i

[Mesh]
  type = GeneratedMesh
  dim = 3
  nx = 10
  ny = 10
  nz = 10
[]

[Adaptivity]
  max_h_level = 5
  initial_steps = 5
  initial_marker = marker
  [./Indicators]
    [./indicator]
      type = GradientJumpIndicator
      variable = u
    [../]
  [../]
  [./Markers]
    [./marker]
      type = ErrorFractionMarker
      indicator = indicator
      refine = 0.9
    [../]
  [../]
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./image_func]
    type = ImageFunction
    file = stack/test_00.png
  [../]
[]

[BCs]
  [./left]
    type = DirichletBC
    variable = u
    boundary = left
    value = 0
  [../]
  [./right]
    type = DirichletBC
    variable = u
    boundary = right
    value = 1
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = image_func
    variable = u
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[../]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  exodus = true
[]

test/tests/functions/image_function/image_mesh_2d.i

[Mesh]
  type = ImageMesh
  dim = 2
  file = stack/test_00.png
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./image_func]
    # ImageFunction gets its file range parameters from ImageMesh,
    # when it is present.  This prevents duplicating information in
    # input files.
    type = ImageFunction
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = image_func
    variable = u
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[../]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
[]

[Outputs]
  exodus = true
[]

test/tests/functions/image_function/crop.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 10
  ny = 10
  uniform_refine = 2
  xmin = 0.5
  ymin = 0.5
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./image_func]
    type = ImageFunction
    file_base = stack/test
    file_range = '0' # file_range is a vector input, a single entry means "read only 1 file"
    file_suffix = png
    origin = '0 0 0'
    dimensions = '1 1 0'
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = image_func
    variable = u
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
[]

[Outputs]
  exodus = true
[]

test/tests/functions/image_function/threshold_adapt_parallel.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 2
  ny = 2
  parallel_type = distributed
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./image_func]
    type = ImageFunction
    file_base = stack/test
    file_suffix = png
    file_range = '0' # file_range is a vector input, a single entry means "read only 1 file"
    threshold = 2.7e4
    upper_value = 1
    lower_value = -1
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = image_func
    variable = u
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
[]

[Adaptivity]
  max_h_level = 5
  initial_steps = 5
  initial_marker = marker
  [./Indicators]
    [./indicator]
      type = GradientJumpIndicator
      variable = u
    [../]
  [../]
  [./Markers]
    [./marker]
      type = ErrorFractionMarker
      indicator = indicator
      refine = 0.9
    [../]
  [../]
[]

[Outputs]
[]

test/tests/functions/image_function/image_mesh_3d.i

[Mesh]
  type = ImageMesh
  dim = 3
  file_base = stack/test
  file_suffix = png
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./image_func]
    # ImageFunction gets its file range parameters from ImageMesh,
    # when it is present.  This prevents duplicating information in
    # input files.
    type = ImageFunction
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = image_func
    variable = u
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[../]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
[]

[Outputs]
  exodus = true
[]

test/tests/functions/image_function/image_3d.i

[Mesh]
  type = GeneratedMesh
  dim = 3
  nx = 20
  ny = 20
  nz = 20
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./image_func]
    type = ImageFunction
    file_base = stack/test
    file_suffix = png
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = image_func
    variable = u
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[../]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 0.1
[]

[Outputs]
  exodus = true
[]

modules/phase_field/test/tests/boundary_intersecting_features/boundary_intersecting_features.i

[Mesh]
  # ImageMesh ignores nx, xmin, xmax (and similarly for y and z) and
  # tries to read them from the image file...
  type = ImageMesh
  dim = 2

  # Be sure to choose a corresponding image name below!
  # file = image001_cropped3_closing_298.png         # full size, 157 Mb Exodus file!
  # file = eighth_image001_cropped3_closing_298.png  # 1/8
  file = sixteenth_image001_cropped3_closing_298.png # 1/16

  # Uncomment to maintain 1:1 ratio between number of pixels and mesh size.
  # scale_to_one = false

  # Uncomment to set cells_per_pixel to something other than the default value of 1.0.
  # Must be <= 1.
  # cells_per_pixel = .75

  # To crop an image to e.g. 1/8th size, install ImageMagick and run:
  #  convert image001_cropped3_closing_298.png -crop 230x198+100+100 eighth_image001_cropped3_closing_298.png
  # Note: Do not use 'sips' on OSX to crop!  It actually interpolates
  # the colors in the image instead of just cropping.
[]

[Variables]
  [./u]
    order = CONSTANT
    family = MONOMIAL
  [../]
[]

[AuxVariables]
  [./grain_auxvar]
    order = CONSTANT
    family = MONOMIAL
  [../]

  [./centroids]
    order = CONSTANT
    family = MONOMIAL
  [../]
[]

[AuxKernels]
  [./nodal_flood_aux]
    variable = grain_auxvar
    type = FeatureFloodCountAux
    flood_counter = flood_count_pp
    execute_on = 'initial timestep_end'
  [../]

  [./centroids]
    type = FeatureFloodCountAux
    variable = centroids
    flood_counter = flood_count_pp
    field_display = CENTROID
    execute_on = 'initial timestep_end'
  [../]
[]

[Functions]
  [./tif]
    # ImageFunction gets its file range parameters from ImageMesh,
    # when it is present.  This prevents duplicating information in
    # input files.
    type = ImageFunction

    # In these sample images the features we want to analyze are RED (or close to pure red). The
    # background is BLUE so we can easily distinguish between the two by selecting only the red channel.
    component = 0
  [../]
[]

[ICs]
  [./u_ic]
    type = FunctionIC
    function = tif
    variable = u
  [../]
[]

[Postprocessors]
  [./flood_count_pp]
    type = FeatureFloodCount
    variable = u
    threshold = 1.0
    compute_var_to_feature_map = true
    execute_on = 'initial timestep_end'
  [../]
[]

[VectorPostprocessors]
  [./grain_volumes]
    type = FeatureVolumeVectorPostprocessor
    flood_counter = flood_count_pp
    execute_on = 'initial timestep_end'
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
[../]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
  csv = true
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools