API Reference

This section contains the automatically generated API documentation.

• eispy2d package
  • Subpackages
    • eispy2d.core package
      • Submodules
      • eispy2d.core.configuration module
      • eispy2d.core.error module
      • Module contents
    • eispy2d.data package
      • Submodules
      • eispy2d.data.inputdata module
      • eispy2d.data.result module
      • eispy2d.data.testset module
      • Module contents
    • eispy2d.discretization package
      • Submodules
      • eispy2d.discretization.collocation module
      • eispy2d.discretization.discretization module
      • eispy2d.discretization.richmond module
      • Module contents
    • eispy2d.evoalglib package
      • Submodules
      • eispy2d.evoalglib.boundary module
      • eispy2d.evoalglib.crossover module
      • eispy2d.evoalglib.de module
      • eispy2d.evoalglib.ga module
      • eispy2d.evoalglib.initialization module
      • eispy2d.evoalglib.mechanism module
      • eispy2d.evoalglib.mutation module
      • eispy2d.evoalglib.objectivefunction module
      • eispy2d.evoalglib.pso module
      • eispy2d.evoalglib.representation module
      • eispy2d.evoalglib.selection module
      • Module contents
    • eispy2d.experiments package
      • Submodules
      • eispy2d.experiments.benchmark module
      • eispy2d.experiments.casestudy module
      • eispy2d.experiments.experiment module
      • Module contents
    • eispy2d.regularization package
      • Submodules
      • eispy2d.regularization.regularization module
      • Module contents
    • eispy2d.solvers package
      • Subpackages
      • Module contents
    • eispy2d.utils package
      • Submodules
      • eispy2d.utils.draw module
      • eispy2d.utils.statisticsutils module
      • eispy2d.utils.stopcriteria module
      • Module contents
  • Module contents
    • Ackley
      • Ackley.eval()
    • Analytical
      • Analytical.name
      • Analytical.contrast
      • Analytical.radius
      • Analytical.incident_field()
      • Analytical.dielectric_cylinder()
      • Analytical.conductor_cylinder()
      • Analytical.save()
      • Analytical.importdata()
      • Analytical.__init__()
      • Analytical.__str__()
      • Analytical.conductor_cylinder()
      • Analytical.dielectric_cylinder()
      • Analytical.importdata()
      • Analytical.incident_field()
      • Analytical.save()
      • Analytical.solve()
    • BackPropagation
      • BackPropagation.name
      • BackPropagation.forward
      • BackPropagation.__init__()
      • BackPropagation.__str__()
      • BackPropagation.copy()
      • BackPropagation.importdata()
      • BackPropagation.save()
      • BackPropagation.solve()
    • Benchmark
      • Benchmark.testset
      • Benchmark.results
      • Benchmark._single_testset
      • Benchmark._testset_available
      • Benchmark.import_testsets()
      • Benchmark.run()
      • Benchmark.plot()
      • Benchmark.boxplot()
      • Benchmark.violinplot()
      • Benchmark.save()
      • Benchmark.importdata()
      • Benchmark.__init__()
      • Benchmark.boxplot()
      • Benchmark.compare()
      • Benchmark.confint()
      • Benchmark.evolution()
      • Benchmark.import_testsets()
      • Benchmark.importdata()
      • Benchmark.normality()
      • Benchmark.plot()
      • Benchmark.reconstruction()
      • Benchmark.run()
      • Benchmark.save()
      • Benchmark.testset
      • Benchmark.violinplot()
    • BinaryTournament
      • BinaryTournament.copy()
      • BinaryTournament.run()
    • Binomial
      • Binomial.copy()
      • Binomial.run()
    • BornApproximation
      • BornApproximation.run()
    • BornIterativeMethod
      • BornIterativeMethod.name
      • BornIterativeMethod.forward
      • BornIterativeMethod.regularization
      • BornIterativeMethod.stop_criteria
      • BornIterativeMethod.solve()
      • BornIterativeMethod.save()
      • BornIterativeMethod.importdata()
      • BornIterativeMethod.copy()
      • BornIterativeMethod.__init__()
      • BornIterativeMethod.__str__()
      • BornIterativeMethod.copy()
      • BornIterativeMethod.importdata()
      • BornIterativeMethod.save()
      • BornIterativeMethod.solve()
    • BoundaryCondition
      • BoundaryCondition.run()
      • BoundaryCondition.run()
    • CanonicalProblems
      • CanonicalProblems.contrast()
      • CanonicalProblems.current()
      • CanonicalProblems.scattered_field()
      • CanonicalProblems.total_field()
    • CaseStudy
      • CaseStudy.test
      • CaseStudy.s_nexec
      • CaseStudy.s_save
      • CaseStudy.results
      • CaseStudy.run()
      • CaseStudy.reconstruction()
      • CaseStudy.convergence()
      • CaseStudy.boxplot()
      • CaseStudy.compare()
      • CaseStudy.confint()
      • CaseStudy.__init__()
      • CaseStudy.__str__()
      • CaseStudy.boxplot()
      • CaseStudy.compare()
      • CaseStudy.confint()
      • CaseStudy.convergence()
      • CaseStudy.importdata()
      • CaseStudy.reconstruction()
      • CaseStudy.run()
      • CaseStudy.save()
      • CaseStudy.test
    • Collocation
      • Collocation.trial
      • Collocation.elements
      • Collocation.name
      • Collocation.alias
      • Collocation.copy()
      • Collocation.save()
      • Collocation.importdata()
      • Collocation.__init__()
      • Collocation.__str__()
      • Collocation.copy()
      • Collocation.importdata()
      • Collocation.save()
    • Configuration
      • Configuration.name
      • Configuration.path
      • Configuration.NM
      • Configuration.NS
      • Configuration.Ro
      • Configuration.Lx
      • Configuration.epsilon_rb
      • Configuration.sigma_b
      • Configuration.frequency
      • Configuration.lambda_b
      • Configuration.kb
      • Configuration.perfect_dielectric
      • Configuration.good_conductor
      • Configuration.E0
      • Configuration.__init__()
      • Configuration.__str__()
      • Configuration.copy()
      • Configuration.draw()
      • Configuration.importdata()
      • Configuration.save()
    • ConjugatedGradient
      • ConjugatedGradient.__init__()
      • ConjugatedGradient.solve()
    • ConjugatedGradientMethod
      • ConjugatedGradientMethod.name
      • ConjugatedGradientMethod.initial_guess
      • ConjugatedGradientMethod.step
      • ConjugatedGradientMethod.stop_criteria
      • ConjugatedGradientMethod.solve()
      • ConjugatedGradientMethod.save()
      • ConjugatedGradientMethod.importdata()
      • ConjugatedGradientMethod.copy()
      • ConjugatedGradientMethod.__init__()
      • ConjugatedGradientMethod.__str__()
      • ConjugatedGradientMethod.copy()
      • ConjugatedGradientMethod.importdata()
      • ConjugatedGradientMethod.save()
      • ConjugatedGradientMethod.solve()
    • ContrastSourceInversion
      • ContrastSourceInversion.__init__()
      • ContrastSourceInversion.__str__()
      • ContrastSourceInversion.copy()
      • ContrastSourceInversion.importdata()
      • ContrastSourceInversion.save()
      • ContrastSourceInversion.solve()
    • Crossover
      • Crossover.run()
      • Crossover.copy()
      • Crossover.copy()
      • Crossover.run()
    • Deterministic
      • Deterministic.alias
      • Deterministic.parallelization
      • Deterministic.name
      • Deterministic.solve()
      • Deterministic.save()
      • Deterministic.importdata()
      • Deterministic.copy()
      • Deterministic.__init__()
      • Deterministic.copy()
      • Deterministic.importdata()
      • Deterministic.save()
      • Deterministic.solve()
    • DifferentialEvolution
      • DifferentialEvolution.run()
      • DifferentialEvolution.copy()
      • DifferentialEvolution.reset_variables()
      • DifferentialEvolution.run()
    • Discretization
      • Discretization.configuration
      • Discretization.name
      • Discretization.alias
      • Discretization.residual_data()
      • Discretization.residual_state()
      • Discretization.solve()
      • Discretization.scattered_field()
      • Discretization.contrast_image()
      • Discretization.total_image()
      • Discretization.copy()
      • Discretization.save()
      • Discretization.importdata()
      • Discretization.__init__()
      • Discretization.__str__()
      • Discretization.contrast_image()
      • Discretization.copy()
      • Discretization.importdata()
      • Discretization.residual_data()
      • Discretization.residual_state()
      • Discretization.save()
      • Discretization.scattered_field()
      • Discretization.solve()
      • Discretization.total_image()
    • DiscretizationElementBased
      • DiscretizationElementBased.contrast()
      • DiscretizationElementBased.current()
      • DiscretizationElementBased.scattered_field()
      • DiscretizationElementBased.total_field()
    • DistortedBornIterativeMethod
      • DistortedBornIterativeMethod.name
      • DistortedBornIterativeMethod.forward
      • DistortedBornIterativeMethod.regularization
      • DistortedBornIterativeMethod.stop_criteria
      • DistortedBornIterativeMethod.alias
      • DistortedBornIterativeMethod.solve()
      • DistortedBornIterativeMethod.save()
      • DistortedBornIterativeMethod.importdata()
      • DistortedBornIterativeMethod.copy()
      • DistortedBornIterativeMethod.__init__()
      • DistortedBornIterativeMethod.__str__()
      • DistortedBornIterativeMethod.copy()
      • DistortedBornIterativeMethod.importdata()
      • DistortedBornIterativeMethod.save()
      • DistortedBornIterativeMethod.solve()
    • EmptyAttribute
      • EmptyAttribute.class_name
      • EmptyAttribute.attribute_name
      • EmptyAttribute.message
      • EmptyAttribute.__init__()
    • Error
    • EvolutionaryAlgorithm
      • EvolutionaryAlgorithm.copy()
      • EvolutionaryAlgorithm.run_algorithm()
      • EvolutionaryAlgorithm.save()
      • EvolutionaryAlgorithm.solve()
    • ExcessiveInputsError
      • ExcessiveInputsError.function_name
      • ExcessiveInputsError.input_names
      • ExcessiveInputsError.__init__()
    • Experiment
      • Experiment.__init__()
      • Experiment.discretization
      • Experiment.importdata()
      • Experiment.method
      • Experiment.save()
    • ExtendedContrastSourceInversion
      • ExtendedContrastSourceInversion.forward
      • ExtendedContrastSourceInversion.stop_criteria
      • ExtendedContrastSourceInversion.name
      • ExtendedContrastSourceInversion.__init__()
      • ExtendedContrastSourceInversion.__str__()
      • ExtendedContrastSourceInversion.copy()
      • ExtendedContrastSourceInversion.importdata()
      • ExtendedContrastSourceInversion.save()
      • ExtendedContrastSourceInversion.solve()
    • FFTProduct
      • FFTProduct.discretization
      • FFTProduct.G
      • FFTProduct.adjoint
      • FFTProduct.conjugate
      • FFTProduct.compute()
      • FFTProduct.compute()
      • FFTProduct.discretization
    • FirstOrderBornApproximation
      • FirstOrderBornApproximation.name
      • FirstOrderBornApproximation.regularization
      • FirstOrderBornApproximation.forward
      • FirstOrderBornApproximation.solve()
      • FirstOrderBornApproximation.save()
      • FirstOrderBornApproximation.importdata()
      • FirstOrderBornApproximation.copy()
      • FirstOrderBornApproximation.__init__()
      • FirstOrderBornApproximation.__str__()
      • FirstOrderBornApproximation.copy()
      • FirstOrderBornApproximation.importdata()
      • FirstOrderBornApproximation.save()
      • FirstOrderBornApproximation.solve()
    • ForwardSolver
      • ForwardSolver.name
      • ForwardSolver.parallelization
      • ForwardSolver.et
      • ForwardSolver.ei
      • ForwardSolver.es
      • ForwardSolver.epsilon_r
      • ForwardSolver.sigma
      • ForwardSolver.configuration
      • ForwardSolver.solve()
      • ForwardSolver.incident_field()
      • ForwardSolver.save()
      • ForwardSolver.importdata()
      • ForwardSolver.__init__()
      • ForwardSolver.__str__()
      • ForwardSolver.importdata()
      • ForwardSolver.incident_field()
      • ForwardSolver.save()
      • ForwardSolver.solve()
    • Gaussian
      • Gaussian.copy()
      • Gaussian.run()
    • GeneticAlgorithm
      • GeneticAlgorithm.run()
      • GeneticAlgorithm.copy()
      • GeneticAlgorithm.reset_variables()
      • GeneticAlgorithm.run()
    • Initialization
      • Initialization.run()
      • Initialization.run()
    • InputData
      • InputData.name
      • InputData.configuration_filename
      • InputData.resolution
      • InputData.scattered_field
      • InputData.total_field
      • InputData.incident_field
      • InputData.relative_permittivity_map
      • InputData.conductivity_map
      • InputData.noise
      • InputData.homogeneous_objects
      • InputData.compute_residual_error
      • InputData.compute_map_error
      • InputData.compute_totalfield_error
      • InputData.__init__()
      • InputData.__str__()
      • InputData.compute_dnl()
      • InputData.configuration
      • InputData.copy()
      • InputData.draw()
      • InputData.importdata()
      • InputData.plot_scattered_field()
      • InputData.plot_total_field()
      • InputData.save()
    • InverseSolver
      • InverseSolver.name
      • InverseSolver.alias
      • InverseSolver.parallelization
      • InverseSolver.execution_time
      • InverseSolver.solve()
      • InverseSolver.save()
      • InverseSolver.importdata()
      • InverseSolver.copy()
      • InverseSolver.__init__()
      • InverseSolver.copy()
      • InverseSolver.importdata()
      • InverseSolver.save()
      • InverseSolver.solve()
    • Landweber
      • Landweber.__init__()
      • Landweber.solve()
    • LeastSquares
      • LeastSquares.__init__()
      • LeastSquares.solve()
    • LinearSamplingMethod
      • LinearSamplingMethod.copy()
      • LinearSamplingMethod.importdata()
      • LinearSamplingMethod.save()
      • LinearSamplingMethod.solve()
    • MRContrastSourceInversion
      • MRContrastSourceInversion.forward
      • MRContrastSourceInversion.inverse
      • MRContrastSourceInversion.MAX_IT
      • MRContrastSourceInversion.sc_measure
      • MRContrastSourceInversion.stopcriterion_measure
      • MRContrastSourceInversion.divergence_tolerance
      • MRContrastSourceInversion.__init__()
      • MRContrastSourceInversion.copy()
      • MRContrastSourceInversion.importdata()
      • MRContrastSourceInversion.save()
      • MRContrastSourceInversion.solve()
    • MUSIC
      • MUSIC.copy()
      • MUSIC.importdata()
      • MUSIC.save()
      • MUSIC.solve()
    • MissingAttributesError
      • MissingAttributesError.class_name
      • MissingAttributesError.attribute_name
      • MissingAttributesError.__init__()
    • MissingInputError
      • MissingInputError.function_name
      • MissingInputError.input_names
      • MissingInputError.message
      • MissingInputError.__init__()
    • MoM_CG_FFT
      • MoM_CG_FFT.TOL
      • MoM_CG_FFT.MAX_IT
      • MoM_CG_FFT.name
      • MoM_CG_FFT.incident_field()
      • MoM_CG_FFT.save()
      • MoM_CG_FFT.importdata()
      • MoM_CG_FFT.CG_FFT()
      • MoM_CG_FFT.__init__()
      • MoM_CG_FFT.__str__()
      • MoM_CG_FFT.importdata()
      • MoM_CG_FFT.incident_field()
      • MoM_CG_FFT.save()
      • MoM_CG_FFT.solve()
    • Mutation
      • Mutation.run()
      • Mutation.copy()
      • Mutation.copy()
      • Mutation.run()
    • ObjectiveFunction
      • ObjectiveFunction.set_parameters()
      • ObjectiveFunction.eval()
      • ObjectiveFunction.eval()
      • ObjectiveFunction.set_parameters()
    • OrthogonalitySamplingMethod
      • OrthogonalitySamplingMethod.copy()
      • OrthogonalitySamplingMethod.importdata()
      • OrthogonalitySamplingMethod.save()
      • OrthogonalitySamplingMethod.solve()
    • OutputMode
      • OutputMode.make()
      • OutputMode.copy()
      • OutputMode.copy()
      • OutputMode.make()
    • ParticleSwarmOptimization
      • ParticleSwarmOptimization.run()
      • ParticleSwarmOptimization.copy()
      • ParticleSwarmOptimization.reset_variables()
      • ParticleSwarmOptimization.run()
    • Polynomial
      • Polynomial.copy()
      • Polynomial.run()
    • Rastrigin
      • Rastrigin.eval()
    • Reflection
      • Reflection.run()
    • Regularization
      • Regularization.solve()
    • Representation
      • Representation.nvar
      • Representation.lb
      • Representation.ub
      • Representation.dtype
      • Representation.contrast()
      • Representation.current()
      • Representation.real2unit()
      • Representation.scattered_field()
      • Representation.total_field()
      • Representation.unit2real()
    • Result
      • Result.name
      • Result.method_name
      • Result.configuration
      • Result.total_field
      • Result.scattered_field
      • Result.rel_permittivity
      • Result.conductivity
      • Result.execution_time
      • Result.number_evaluations
      • Result.number_iterations
      • Result.objective_function
      • Result.zeta_rn
      • Result.zeta_rpad
      • Result.zeta_epad
      • Result.zeta_ebe
      • Result.zeta_eoe
      • Result.zeta_sad
      • Result.zeta_sbe
      • Result.zeta_soe
      • Result.zeta_tv
      • Result.zeta_p
      • Result.zeta_s
      • Result.zeta_tfmpad
      • Result.zeta_tfpad
      • Result.__init__()
      • Result.__str__()
      • Result.copy()
      • Result.final_value()
      • Result.importdata()
      • Result.last_error_message()
      • Result.plot_convergence()
      • Result.plot_map()
      • Result.save()
      • Result.update_error()
      • Result.valid_indicators()
    • Richmond
      • Richmond.GS
      • Richmond.GD
      • Richmond.residual_data()
      • Richmond.residual_state()
      • Richmond.solve()
      • Richmond.scattered_field()
      • Richmond.contrast_image()
      • Richmond.total_image()
      • Richmond.contrast_image()
      • Richmond.copy()
      • Richmond.importdata()
      • Richmond.residual_data()
      • Richmond.residual_state()
      • Richmond.save()
      • Richmond.scattered_field()
      • Richmond.solve()
      • Richmond.total_image()
    • Rosenbrock
      • Rosenbrock.eval()
    • Roullete
      • Roullete.copy()
      • Roullete.run()
    • Selection
      • Selection.run()
      • Selection.copy()
      • Selection.copy()
      • Selection.run()
    • SimulatedBinary
      • SimulatedBinary.copy()
      • SimulatedBinary.run()
    • SingularValueDecomposition
      • SingularValueDecomposition.__init__()
      • SingularValueDecomposition.solve()
    • Stochastic
      • Stochastic.nexec
      • Stochastic.outputmode
      • Stochastic._single_execution
      • Stochastic.copy()
      • Stochastic.importdata()
      • Stochastic.nexec
      • Stochastic.save()
      • Stochastic.solve()
    • StopCriteria
      • StopCriteria.__init__()
      • StopCriteria.__str__()
      • StopCriteria.copy()
      • StopCriteria.reset_memory()
      • StopCriteria.stop()
    • SubspaceBasedOptimizationMethod
      • SubspaceBasedOptimizationMethod.forward
      • SubspaceBasedOptimizationMethod.inverse
      • SubspaceBasedOptimizationMethod.MAX_IT
      • SubspaceBasedOptimizationMethod.sc_measure
      • SubspaceBasedOptimizationMethod.stopcriterion_measure
      • SubspaceBasedOptimizationMethod.divergence_tolerance
      • SubspaceBasedOptimizationMethod.__init__()
      • SubspaceBasedOptimizationMethod.copy()
      • SubspaceBasedOptimizationMethod.importdata()
      • SubspaceBasedOptimizationMethod.save()
      • SubspaceBasedOptimizationMethod.solve()
    • TestSet
      • TestSet.__init__()
      • TestSet.configuration
      • TestSet.copy()
      • TestSet.generate_field_data()
      • TestSet.importdata()
      • TestSet.plot()
      • TestSet.randomize_tests()
      • TestSet.save()
      • TestSet.test
    • Tikhonov
      • Tikhonov.__init__()
      • Tikhonov.solve()
    • UniformRandomDistribution
      • UniformRandomDistribution.run()
    • WeightedSum
      • WeightedSum.eval()
    • WrongTypeInput
      • WrongTypeInput.__init__()
    • WrongValueInput
      • WrongValueInput.expected_values
      • WrongValueInput.given_value
      • WrongValueInput.__init__()
    • circle()
    • compare1sample()
    • compare2samples()
    • compare_multiple()
    • confint()
    • confintplot()
    • cross()
    • dunnetttest()
    • ellipse()
    • factorial_analysis()
    • homoscedasticityplot()
    • line()
    • normalitiyplot()
    • parallelogram()
    • polygon()
    • random()
    • random_gaussians()
    • random_waves()
    • rcbd()
    • rhombus()
    • ring()
    • square()
    • star4()
    • star5()
    • star6()
    • trapezoid()
    • triangle()
    • wave()